fhir-swagger-generator.4.8.3.source-code.profiles-resources.json Maven / Gradle / Ivy
{
"resourceType" : "Bundle",
"id" : "resources",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"type" : "collection",
"entry" : [{
"fullUrl" : "http://hl7.org/fhir/CapabilityStatement/base",
"resource" : {
"resourceType" : "CapabilityStatement",
"id" : "base",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Base FHIR Capability Statement (Full)
This is the base Capability Statement for FHIR. It represents a server that provides the full set of functionality defined by FHIR. It is provided to use as a template for system designers to build their own Capability Statements from
\nMode SERVER Description All the functionality defined in FHIR Transaction y System History y System Search y
Base FHIR Capability Statement (Full)
This is the base Capability Statement for FHIR. It represents a server that provides the full set of functionality defined by FHIR. It is provided to use as a template for system designers to build their own Capability Statements from
\nMode SERVER Description All the functionality defined in FHIR Transaction y System History y System Search y
"
},
"url" : "http://hl7.org/fhir/CapabilityStatement/base",
"version" : "4.0.0",
"name" : "Base FHIR Capability Statement (Full)",
"status" : "draft",
"experimental" : true,
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "FHIR Project Team",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
}],
"description" : "This is the base Capability Statement for FHIR. It represents a server that provides the full set of functionality defined by FHIR. It is provided to use as a template for system designers to build their own Capability Statements from",
"kind" : "capability",
"software" : {
"name" : "Insert your software name here..."
},
"fhirVersion" : "4.0.0",
"format" : ["xml",
"json"],
"rest" : [{
"mode" : "server",
"documentation" : "All the functionality defined in FHIR",
"security" : {
"cors" : true,
"service" : [{
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/restful-security-service",
"code" : "SMART-on-FHIR",
"display" : "SMART-on-FHIR"
}],
"text" : "See http://docs.smarthealthit.org/"
}],
"description" : "This is the Capability Statement to declare that the server supports SMART-on-FHIR. See the SMART-on-FHIR docs for the extension that would go with such a server"
},
"resource" : [{
"type" : "Account",
"profile" : "http://hl7.org/fhir/StructureDefinition/Account",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Account.owner",
"Account.subject",
"Account.patient"],
"searchRevInclude" : ["ChargeItem.account",
"Encounter.account",
"Invoice.account"],
"searchParam" : [{
"name" : "owner",
"definition" : "http://hl7.org/fhir/SearchParameter/Account-owner",
"type" : "reference",
"documentation" : "Entity managing the Account"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Account-identifier",
"type" : "token",
"documentation" : "Account number"
},
{
"name" : "period",
"definition" : "http://hl7.org/fhir/SearchParameter/Account-period",
"type" : "date",
"documentation" : "Transaction window"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/Account-subject",
"type" : "reference",
"documentation" : "The entity that caused the expenses"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/Account-patient",
"type" : "reference",
"documentation" : "The entity that caused the expenses"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/Account-name",
"type" : "string",
"documentation" : "Human-readable label"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/Account-type",
"type" : "token",
"documentation" : "E.g. patient, expense, depreciation"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Account-status",
"type" : "token",
"documentation" : "active | inactive | entered-in-error | on-hold | unknown"
}]
},
{
"type" : "ActivityDefinition",
"profile" : "http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["ActivityDefinition.successor",
"ActivityDefinition.derived-from",
"ActivityDefinition.predecessor",
"ActivityDefinition.composed-of",
"ActivityDefinition.depends-on"],
"searchRevInclude" : ["CarePlan.instantiates-canonical",
"Communication.instantiates-canonical",
"DeviceRequest.instantiates-canonical",
"FamilyMemberHistory.instantiates-canonical",
"MessageDefinition.parent",
"NutritionOrder.instantiates-canonical",
"PlanDefinition.definition",
"Procedure.instantiates-canonical",
"ServiceRequest.instantiates-canonical"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-date",
"type" : "date",
"documentation" : "The activity definition publication date"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-identifier",
"type" : "token",
"documentation" : "External identifier for the activity definition"
},
{
"name" : "successor",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-successor",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the activity definition"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the activity definition"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-description",
"type" : "string",
"documentation" : "The description of the activity definition"
},
{
"name" : "derived-from",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-derived-from",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the activity definition"
},
{
"name" : "predecessor",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-predecessor",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-title",
"type" : "string",
"documentation" : "The human-friendly name of the activity definition"
},
{
"name" : "composed-of",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-composed-of",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-version",
"type" : "token",
"documentation" : "The business version of the activity definition"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-url",
"type" : "uri",
"documentation" : "The uri that identifies the activity definition"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the activity definition"
},
{
"name" : "effective",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-effective",
"type" : "date",
"documentation" : "The time during which the activity definition is intended to be in use"
},
{
"name" : "depends-on",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-depends-on",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-name",
"type" : "string",
"documentation" : "Computationally friendly name of the activity definition"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-context",
"type" : "token",
"documentation" : "A use context assigned to the activity definition"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the activity definition"
},
{
"name" : "topic",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-topic",
"type" : "token",
"documentation" : "Topics associated with the module"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the activity definition"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-status",
"type" : "token",
"documentation" : "The current status of the activity definition"
}]
},
{
"type" : "AdverseEvent",
"profile" : "http://hl7.org/fhir/StructureDefinition/AdverseEvent",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["AdverseEvent.recorder",
"AdverseEvent.study",
"AdverseEvent.subject",
"AdverseEvent.resultingcondition",
"AdverseEvent.substance",
"AdverseEvent.location"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/AdverseEvent-date",
"type" : "date",
"documentation" : "When the event occurred"
},
{
"name" : "severity",
"definition" : "http://hl7.org/fhir/SearchParameter/AdverseEvent-severity",
"type" : "token",
"documentation" : "mild | moderate | severe"
},
{
"name" : "recorder",
"definition" : "http://hl7.org/fhir/SearchParameter/AdverseEvent-recorder",
"type" : "reference",
"documentation" : "Who recorded the adverse event"
},
{
"name" : "study",
"definition" : "http://hl7.org/fhir/SearchParameter/AdverseEvent-study",
"type" : "reference",
"documentation" : "AdverseEvent.study"
},
{
"name" : "actuality",
"definition" : "http://hl7.org/fhir/SearchParameter/AdverseEvent-actuality",
"type" : "token",
"documentation" : "actual | potential"
},
{
"name" : "seriousness",
"definition" : "http://hl7.org/fhir/SearchParameter/AdverseEvent-seriousness",
"type" : "token",
"documentation" : "Seriousness of the event"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/AdverseEvent-subject",
"type" : "reference",
"documentation" : "Subject impacted by event"
},
{
"name" : "resultingcondition",
"definition" : "http://hl7.org/fhir/SearchParameter/AdverseEvent-resultingcondition",
"type" : "reference",
"documentation" : "Effect on the subject due to this event"
},
{
"name" : "substance",
"definition" : "http://hl7.org/fhir/SearchParameter/AdverseEvent-substance",
"type" : "reference",
"documentation" : "Refers to the specific entity that caused the adverse event"
},
{
"name" : "location",
"definition" : "http://hl7.org/fhir/SearchParameter/AdverseEvent-location",
"type" : "reference",
"documentation" : "Location where adverse event occurred"
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/AdverseEvent-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",
"definition" : "http://hl7.org/fhir/SearchParameter/AdverseEvent-event",
"type" : "token",
"documentation" : "Type of the event itself in relation to the subject"
}]
},
{
"type" : "AllergyIntolerance",
"profile" : "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["AllergyIntolerance.recorder",
"AllergyIntolerance.asserter",
"AllergyIntolerance.patient"],
"searchRevInclude" : ["ClinicalImpression.problem"],
"searchParam" : [{
"name" : "severity",
"definition" : "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-severity",
"type" : "token",
"documentation" : "mild | moderate | severe (of event as a whole)"
},
{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "Date first version of the resource instance was recorded"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "External ids for this item"
},
{
"name" : "manifestation",
"definition" : "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-manifestation",
"type" : "token",
"documentation" : "Clinical symptoms/signs associated with the Event"
},
{
"name" : "recorder",
"definition" : "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-recorder",
"type" : "reference",
"documentation" : "Who recorded the sensitivity"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "Code that identifies the allergy or intolerance"
},
{
"name" : "verification-status",
"definition" : "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-verification-status",
"type" : "token",
"documentation" : "unconfirmed | confirmed | refuted | entered-in-error"
},
{
"name" : "criticality",
"definition" : "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-criticality",
"type" : "token",
"documentation" : "low | high | unable-to-assess"
},
{
"name" : "clinical-status",
"definition" : "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-clinical-status",
"type" : "token",
"documentation" : "active | inactive | resolved"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-type",
"type" : "token",
"documentation" : "allergy | intolerance - Underlying mechanism (if known)"
},
{
"name" : "onset",
"definition" : "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-onset",
"type" : "date",
"documentation" : "Date(/time) when manifestations showed"
},
{
"name" : "route",
"definition" : "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-route",
"type" : "token",
"documentation" : "How the subject was exposed to the substance"
},
{
"name" : "asserter",
"definition" : "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-asserter",
"type" : "reference",
"documentation" : "Source of the information about the allergy"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Who the sensitivity is for"
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-category",
"type" : "token",
"documentation" : "food | medication | environment | biologic"
},
{
"name" : "last-date",
"definition" : "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-last-date",
"type" : "date",
"documentation" : "Date(/time) of last known occurrence of a reaction"
}]
},
{
"type" : "Appointment",
"profile" : "http://hl7.org/fhir/StructureDefinition/Appointment",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Appointment.practitioner",
"Appointment.slot",
"Appointment.actor",
"Appointment.based-on",
"Appointment.patient",
"Appointment.reason-reference",
"Appointment.supporting-info",
"Appointment.location"],
"searchRevInclude" : ["AppointmentResponse.appointment",
"CarePlan.activity-reference",
"Encounter.appointment",
"ImagingStudy.basedon"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/Appointment-date",
"type" : "date",
"documentation" : "Appointment date/time."
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Appointment-identifier",
"type" : "token",
"documentation" : "An Identifier of the Appointment"
},
{
"name" : "specialty",
"definition" : "http://hl7.org/fhir/SearchParameter/Appointment-specialty",
"type" : "token",
"documentation" : "The specialty of a practitioner that would be required to perform the service requested in this appointment"
},
{
"name" : "service-category",
"definition" : "http://hl7.org/fhir/SearchParameter/Appointment-service-category",
"type" : "token",
"documentation" : "A broad categorization of the service that is to be performed during this appointment"
},
{
"name" : "practitioner",
"definition" : "http://hl7.org/fhir/SearchParameter/Appointment-practitioner",
"type" : "reference",
"documentation" : "One of the individuals of the appointment is this practitioner"
},
{
"name" : "part-status",
"definition" : "http://hl7.org/fhir/SearchParameter/Appointment-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",
"definition" : "http://hl7.org/fhir/SearchParameter/Appointment-appointment-type",
"type" : "token",
"documentation" : "The style of appointment or patient that has been booked in the slot (not service type)"
},
{
"name" : "service-type",
"definition" : "http://hl7.org/fhir/SearchParameter/Appointment-service-type",
"type" : "token",
"documentation" : "The specific service that is to be performed during this appointment"
},
{
"name" : "slot",
"definition" : "http://hl7.org/fhir/SearchParameter/Appointment-slot",
"type" : "reference",
"documentation" : "The slots that this appointment is filling"
},
{
"name" : "reason-code",
"definition" : "http://hl7.org/fhir/SearchParameter/Appointment-reason-code",
"type" : "token",
"documentation" : "Coded reason this appointment is scheduled"
},
{
"name" : "actor",
"definition" : "http://hl7.org/fhir/SearchParameter/Appointment-actor",
"type" : "reference",
"documentation" : "Any one of the individuals participating in the appointment"
},
{
"name" : "based-on",
"definition" : "http://hl7.org/fhir/SearchParameter/Appointment-based-on",
"type" : "reference",
"documentation" : "The service request this appointment is allocated to assess"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/Appointment-patient",
"type" : "reference",
"documentation" : "One of the individuals of the appointment is this patient"
},
{
"name" : "reason-reference",
"definition" : "http://hl7.org/fhir/SearchParameter/Appointment-reason-reference",
"type" : "reference",
"documentation" : "Reason the appointment is to take place (resource)"
},
{
"name" : "supporting-info",
"definition" : "http://hl7.org/fhir/SearchParameter/Appointment-supporting-info",
"type" : "reference",
"documentation" : "Additional information to support the appointment"
},
{
"name" : "location",
"definition" : "http://hl7.org/fhir/SearchParameter/Appointment-location",
"type" : "reference",
"documentation" : "This location is listed in the participants of the appointment"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Appointment-status",
"type" : "token",
"documentation" : "The overall status of the appointment"
}]
},
{
"type" : "AppointmentResponse",
"profile" : "http://hl7.org/fhir/StructureDefinition/AppointmentResponse",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["AppointmentResponse.actor",
"AppointmentResponse.practitioner",
"AppointmentResponse.patient",
"AppointmentResponse.appointment",
"AppointmentResponse.location"],
"searchRevInclude" : ["ImagingStudy.basedon"],
"searchParam" : [{
"name" : "actor",
"definition" : "http://hl7.org/fhir/SearchParameter/AppointmentResponse-actor",
"type" : "reference",
"documentation" : "The Person, Location/HealthcareService or Device that this appointment response replies for"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/AppointmentResponse-identifier",
"type" : "token",
"documentation" : "An Identifier in this appointment response"
},
{
"name" : "practitioner",
"definition" : "http://hl7.org/fhir/SearchParameter/AppointmentResponse-practitioner",
"type" : "reference",
"documentation" : "This Response is for this Practitioner"
},
{
"name" : "part-status",
"definition" : "http://hl7.org/fhir/SearchParameter/AppointmentResponse-part-status",
"type" : "token",
"documentation" : "The participants acceptance status for this appointment"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/AppointmentResponse-patient",
"type" : "reference",
"documentation" : "This Response is for this Patient"
},
{
"name" : "appointment",
"definition" : "http://hl7.org/fhir/SearchParameter/AppointmentResponse-appointment",
"type" : "reference",
"documentation" : "The appointment that the response is attached to"
},
{
"name" : "location",
"definition" : "http://hl7.org/fhir/SearchParameter/AppointmentResponse-location",
"type" : "reference",
"documentation" : "This Response is for this Location"
}]
},
{
"type" : "AuditEvent",
"profile" : "http://hl7.org/fhir/StructureDefinition/AuditEvent",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["AuditEvent.agent",
"AuditEvent.source",
"AuditEvent.patient",
"AuditEvent.entity"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/AuditEvent-date",
"type" : "date",
"documentation" : "Time when the event was recorded"
},
{
"name" : "entity-type",
"definition" : "http://hl7.org/fhir/SearchParameter/AuditEvent-entity-type",
"type" : "token",
"documentation" : "Type of entity involved"
},
{
"name" : "agent",
"definition" : "http://hl7.org/fhir/SearchParameter/AuditEvent-agent",
"type" : "reference",
"documentation" : "Identifier of who"
},
{
"name" : "address",
"definition" : "http://hl7.org/fhir/SearchParameter/AuditEvent-address",
"type" : "string",
"documentation" : "Identifier for the network access point of the user device"
},
{
"name" : "entity-role",
"definition" : "http://hl7.org/fhir/SearchParameter/AuditEvent-entity-role",
"type" : "token",
"documentation" : "What role the entity played"
},
{
"name" : "source",
"definition" : "http://hl7.org/fhir/SearchParameter/AuditEvent-source",
"type" : "reference",
"documentation" : "The identity of source detecting the event"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/AuditEvent-type",
"type" : "token",
"documentation" : "Type/identifier of event"
},
{
"name" : "altid",
"definition" : "http://hl7.org/fhir/SearchParameter/AuditEvent-altid",
"type" : "token",
"documentation" : "Alternative User identity"
},
{
"name" : "site",
"definition" : "http://hl7.org/fhir/SearchParameter/AuditEvent-site",
"type" : "token",
"documentation" : "Logical source location within the enterprise"
},
{
"name" : "agent-name",
"definition" : "http://hl7.org/fhir/SearchParameter/AuditEvent-agent-name",
"type" : "string",
"documentation" : "Human friendly name for the agent"
},
{
"name" : "entity-name",
"definition" : "http://hl7.org/fhir/SearchParameter/AuditEvent-entity-name",
"type" : "string",
"documentation" : "Descriptor for entity"
},
{
"name" : "subtype",
"definition" : "http://hl7.org/fhir/SearchParameter/AuditEvent-subtype",
"type" : "token",
"documentation" : "More specific type/id for the event"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/AuditEvent-patient",
"type" : "reference",
"documentation" : "Identifier of who"
},
{
"name" : "action",
"definition" : "http://hl7.org/fhir/SearchParameter/AuditEvent-action",
"type" : "token",
"documentation" : "Type of action performed during the event"
},
{
"name" : "agent-role",
"definition" : "http://hl7.org/fhir/SearchParameter/AuditEvent-agent-role",
"type" : "token",
"documentation" : "Agent role in the event"
},
{
"name" : "entity",
"definition" : "http://hl7.org/fhir/SearchParameter/AuditEvent-entity",
"type" : "reference",
"documentation" : "Specific instance of resource"
},
{
"name" : "outcome",
"definition" : "http://hl7.org/fhir/SearchParameter/AuditEvent-outcome",
"type" : "token",
"documentation" : "Whether the event succeeded or failed"
},
{
"name" : "policy",
"definition" : "http://hl7.org/fhir/SearchParameter/AuditEvent-policy",
"type" : "uri",
"documentation" : "Policy that authorized event"
}]
},
{
"type" : "Basic",
"profile" : "http://hl7.org/fhir/StructureDefinition/Basic",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Basic.subject",
"Basic.patient",
"Basic.author"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Basic-identifier",
"type" : "token",
"documentation" : "Business identifier"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/Basic-code",
"type" : "token",
"documentation" : "Kind of Resource"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/Basic-subject",
"type" : "reference",
"documentation" : "Identifies the focus of this resource"
},
{
"name" : "created",
"definition" : "http://hl7.org/fhir/SearchParameter/Basic-created",
"type" : "date",
"documentation" : "When created"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/Basic-patient",
"type" : "reference",
"documentation" : "Identifies the focus of this resource"
},
{
"name" : "author",
"definition" : "http://hl7.org/fhir/SearchParameter/Basic-author",
"type" : "reference",
"documentation" : "Who created"
}]
},
{
"type" : "Binary",
"profile" : "http://hl7.org/fhir/StructureDefinition/Binary",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"]
},
{
"type" : "BiologicallyDerivedProduct",
"profile" : "http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProduct",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"]
},
{
"type" : "BodyStructure",
"profile" : "http://hl7.org/fhir/StructureDefinition/BodyStructure",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["BodyStructure.patient"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/BodyStructure-identifier",
"type" : "token",
"documentation" : "Bodystructure identifier"
},
{
"name" : "morphology",
"definition" : "http://hl7.org/fhir/SearchParameter/BodyStructure-morphology",
"type" : "token",
"documentation" : "Kind of Structure"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/BodyStructure-patient",
"type" : "reference",
"documentation" : "Who this is about"
},
{
"name" : "location",
"definition" : "http://hl7.org/fhir/SearchParameter/BodyStructure-location",
"type" : "token",
"documentation" : "Body site"
}]
},
{
"type" : "Bundle",
"profile" : "http://hl7.org/fhir/StructureDefinition/Bundle",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Bundle.composition",
"Bundle.message"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Bundle-identifier",
"type" : "token",
"documentation" : "Persistent identifier for the bundle"
},
{
"name" : "composition",
"definition" : "http://hl7.org/fhir/SearchParameter/Bundle-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",
"definition" : "http://hl7.org/fhir/SearchParameter/Bundle-type",
"type" : "token",
"documentation" : "document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection"
},
{
"name" : "message",
"definition" : "http://hl7.org/fhir/SearchParameter/Bundle-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",
"definition" : "http://hl7.org/fhir/SearchParameter/Bundle-timestamp",
"type" : "date",
"documentation" : "When the bundle was assembled"
}]
},
{
"type" : "CapabilityStatement",
"profile" : "http://hl7.org/fhir/StructureDefinition/CapabilityStatement",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["CapabilityStatement.resource-profile",
"CapabilityStatement.supported-profile",
"CapabilityStatement.guide"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-date",
"type" : "date",
"documentation" : "The capability statement publication date"
},
{
"name" : "resource-profile",
"definition" : "http://hl7.org/fhir/SearchParameter/CapabilityStatement-resource-profile",
"type" : "reference",
"documentation" : "A profile id invoked in a capability statement"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the capability statement"
},
{
"name" : "software",
"definition" : "http://hl7.org/fhir/SearchParameter/CapabilityStatement-software",
"type" : "string",
"documentation" : "Part of the name of a software application"
},
{
"name" : "resource",
"definition" : "http://hl7.org/fhir/SearchParameter/CapabilityStatement-resource",
"type" : "token",
"documentation" : "Name of a resource mentioned in a capability statement"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the capability statement"
},
{
"name" : "format",
"definition" : "http://hl7.org/fhir/SearchParameter/CapabilityStatement-format",
"type" : "token",
"documentation" : "formats supported (xml | json | ttl | mime type)"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-description",
"type" : "string",
"documentation" : "The description of the capability statement"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the capability statement"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-title",
"type" : "string",
"documentation" : "The human-friendly name of the capability statement"
},
{
"name" : "fhirversion",
"definition" : "http://hl7.org/fhir/SearchParameter/CapabilityStatement-fhirversion",
"type" : "token",
"documentation" : "The version of FHIR"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-version",
"type" : "token",
"documentation" : "The business version of the capability statement"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-url",
"type" : "uri",
"documentation" : "The uri that identifies the capability statement"
},
{
"name" : "supported-profile",
"definition" : "http://hl7.org/fhir/SearchParameter/CapabilityStatement-supported-profile",
"type" : "reference",
"documentation" : "Profiles for use cases supported"
},
{
"name" : "mode",
"definition" : "http://hl7.org/fhir/SearchParameter/CapabilityStatement-mode",
"type" : "token",
"documentation" : "Mode - restful (server/client) or messaging (sender/receiver)"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the capability statement"
},
{
"name" : "security-service",
"definition" : "http://hl7.org/fhir/SearchParameter/CapabilityStatement-security-service",
"type" : "token",
"documentation" : "OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-name",
"type" : "string",
"documentation" : "Computationally friendly name of the capability statement"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context",
"type" : "token",
"documentation" : "A use context assigned to the capability statement"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the capability statement"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the capability statement"
},
{
"name" : "guide",
"definition" : "http://hl7.org/fhir/SearchParameter/CapabilityStatement-guide",
"type" : "reference",
"documentation" : "Implementation guides supported"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-status",
"type" : "token",
"documentation" : "The current status of the capability statement"
}]
},
{
"type" : "CarePlan",
"profile" : "http://hl7.org/fhir/StructureDefinition/CarePlan",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["CarePlan.care-team",
"CarePlan.performer",
"CarePlan.goal",
"CarePlan.subject",
"CarePlan.replaces",
"CarePlan.instantiates-canonical",
"CarePlan.part-of",
"CarePlan.encounter",
"CarePlan.activity-reference",
"CarePlan.condition",
"CarePlan.based-on",
"CarePlan.patient"],
"searchRevInclude" : ["CarePlan.replaces",
"CarePlan.part-of",
"CarePlan.based-on",
"DiagnosticReport.based-on",
"ImagingStudy.basedon",
"Media.based-on",
"Observation.based-on",
"Procedure.based-on",
"QuestionnaireResponse.based-on",
"ServiceRequest.based-on"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "Time period plan covers"
},
{
"name" : "care-team",
"definition" : "http://hl7.org/fhir/SearchParameter/CarePlan-care-team",
"type" : "reference",
"documentation" : "Who's involved in plan?"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "External Ids for this plan"
},
{
"name" : "performer",
"definition" : "http://hl7.org/fhir/SearchParameter/CarePlan-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" : "goal",
"definition" : "http://hl7.org/fhir/SearchParameter/CarePlan-goal",
"type" : "reference",
"documentation" : "Desired outcome of plan"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/CarePlan-subject",
"type" : "reference",
"documentation" : "Who the care plan is for"
},
{
"name" : "replaces",
"definition" : "http://hl7.org/fhir/SearchParameter/CarePlan-replaces",
"type" : "reference",
"documentation" : "CarePlan replaced by this CarePlan"
},
{
"name" : "instantiates-canonical",
"definition" : "http://hl7.org/fhir/SearchParameter/CarePlan-instantiates-canonical",
"type" : "reference",
"documentation" : "Instantiates FHIR protocol or definition"
},
{
"name" : "part-of",
"definition" : "http://hl7.org/fhir/SearchParameter/CarePlan-part-of",
"type" : "reference",
"documentation" : "Part of referenced CarePlan"
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/CarePlan-encounter",
"type" : "reference",
"documentation" : "Encounter created as part of"
},
{
"name" : "intent",
"definition" : "http://hl7.org/fhir/SearchParameter/CarePlan-intent",
"type" : "token",
"documentation" : "proposal | plan | order | option"
},
{
"name" : "activity-reference",
"definition" : "http://hl7.org/fhir/SearchParameter/CarePlan-activity-reference",
"type" : "reference",
"documentation" : "Activity details defined in specific resource"
},
{
"name" : "condition",
"definition" : "http://hl7.org/fhir/SearchParameter/CarePlan-condition",
"type" : "reference",
"documentation" : "Health issues this plan addresses"
},
{
"name" : "based-on",
"definition" : "http://hl7.org/fhir/SearchParameter/CarePlan-based-on",
"type" : "reference",
"documentation" : "Fulfills CarePlan"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Who the care plan is for"
},
{
"name" : "activity-date",
"definition" : "http://hl7.org/fhir/SearchParameter/CarePlan-activity-date",
"type" : "date",
"documentation" : "Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x]"
},
{
"name" : "instantiates-uri",
"definition" : "http://hl7.org/fhir/SearchParameter/CarePlan-instantiates-uri",
"type" : "uri",
"documentation" : "Instantiates external protocol or definition"
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/CarePlan-category",
"type" : "token",
"documentation" : "Type of plan"
},
{
"name" : "activity-code",
"definition" : "http://hl7.org/fhir/SearchParameter/CarePlan-activity-code",
"type" : "token",
"documentation" : "Detail type of activity"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/CarePlan-status",
"type" : "token",
"documentation" : "draft | active | suspended | completed | entered-in-error | cancelled | unknown"
}]
},
{
"type" : "CareTeam",
"profile" : "http://hl7.org/fhir/StructureDefinition/CareTeam",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["CareTeam.patient",
"CareTeam.subject",
"CareTeam.encounter",
"CareTeam.participant"],
"searchRevInclude" : ["CarePlan.care-team",
"CarePlan.performer",
"CareTeam.participant",
"ChargeItem.performer-actor",
"Communication.recipient",
"CommunicationRequest.recipient",
"Consent.actor",
"DeviceRequest.performer",
"DiagnosticReport.performer",
"DiagnosticReport.results-interpreter",
"ImagingStudy.performer",
"Media.operator",
"MedicationRequest.intended-performer",
"Observation.performer",
"ServiceRequest.performer",
"Task.owner"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "Time period team covers"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "External Ids for this team"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Who care team is for"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/CareTeam-subject",
"type" : "reference",
"documentation" : "Who care team is for"
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/CareTeam-encounter",
"type" : "reference",
"documentation" : "Encounter created as part of"
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/CareTeam-category",
"type" : "token",
"documentation" : "Type of team"
},
{
"name" : "participant",
"definition" : "http://hl7.org/fhir/SearchParameter/CareTeam-participant",
"type" : "reference",
"documentation" : "Who is involved"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/CareTeam-status",
"type" : "token",
"documentation" : "proposed | active | suspended | inactive | entered-in-error"
}]
},
{
"type" : "CatalogEntry",
"profile" : "http://hl7.org/fhir/StructureDefinition/CatalogEntry",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"]
},
{
"type" : "ChargeItem",
"profile" : "http://hl7.org/fhir/StructureDefinition/ChargeItem",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["ChargeItem.performing-organization",
"ChargeItem.subject",
"ChargeItem.patient",
"ChargeItem.service",
"ChargeItem.context",
"ChargeItem.enterer",
"ChargeItem.performer-actor",
"ChargeItem.account",
"ChargeItem.requesting-organization"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItem-identifier",
"type" : "token",
"documentation" : "Business Identifier for item"
},
{
"name" : "performing-organization",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItem-performing-organization",
"type" : "reference",
"documentation" : "Organization providing the charged service"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItem-code",
"type" : "token",
"documentation" : "A code that identifies the charge, like a billing code"
},
{
"name" : "quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItem-quantity",
"type" : "quantity",
"documentation" : "Quantity of which the charge item has been serviced"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItem-subject",
"type" : "reference",
"documentation" : "Individual service was done for/to"
},
{
"name" : "occurrence",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItem-occurrence",
"type" : "date",
"documentation" : "When the charged service was applied"
},
{
"name" : "entered-date",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItem-entered-date",
"type" : "date",
"documentation" : "Date the charge item was entered"
},
{
"name" : "performer-function",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItem-performer-function",
"type" : "token",
"documentation" : "What type of performance was done"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItem-patient",
"type" : "reference",
"documentation" : "Individual service was done for/to"
},
{
"name" : "factor-override",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItem-factor-override",
"type" : "number",
"documentation" : "Factor overriding the associated rules"
},
{
"name" : "service",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItem-service",
"type" : "reference",
"documentation" : "Which rendered service is being charged?"
},
{
"name" : "price-override",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItem-price-override",
"type" : "quantity",
"documentation" : "Price overriding the associated rules"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItem-context",
"type" : "reference",
"documentation" : "Encounter / Episode associated with event"
},
{
"name" : "enterer",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItem-enterer",
"type" : "reference",
"documentation" : "Individual who was entering"
},
{
"name" : "performer-actor",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItem-performer-actor",
"type" : "reference",
"documentation" : "Individual who was performing"
},
{
"name" : "account",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItem-account",
"type" : "reference",
"documentation" : "Account to place this charge"
},
{
"name" : "requesting-organization",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItem-requesting-organization",
"type" : "reference",
"documentation" : "Organization requesting the charged service"
}]
},
{
"type" : "ChargeItemDefinition",
"profile" : "http://hl7.org/fhir/StructureDefinition/ChargeItemDefinition",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-date",
"type" : "date",
"documentation" : "The charge item definition publication date"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-identifier",
"type" : "token",
"documentation" : "External identifier for the charge item definition"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the charge item definition"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the charge item definition"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-description",
"type" : "string",
"documentation" : "The description of the charge item definition"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the charge item definition"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-title",
"type" : "string",
"documentation" : "The human-friendly name of the charge item definition"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-version",
"type" : "token",
"documentation" : "The business version of the charge item definition"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-url",
"type" : "uri",
"documentation" : "The uri that identifies the charge item definition"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the charge item definition"
},
{
"name" : "effective",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-effective",
"type" : "date",
"documentation" : "The time during which the charge item definition is intended to be in use"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-context",
"type" : "token",
"documentation" : "A use context assigned to the charge item definition"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the charge item definition"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the charge item definition"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-status",
"type" : "token",
"documentation" : "The current status of the charge item definition"
}]
},
{
"type" : "Claim",
"profile" : "http://hl7.org/fhir/StructureDefinition/Claim",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Claim.care-team",
"Claim.encounter",
"Claim.payee",
"Claim.provider",
"Claim.patient",
"Claim.insurer",
"Claim.detail-udi",
"Claim.enterer",
"Claim.procedure-udi",
"Claim.subdetail-udi",
"Claim.facility",
"Claim.item-udi"],
"searchRevInclude" : ["ClaimResponse.request",
"ExplanationOfBenefit.claim"],
"searchParam" : [{
"name" : "care-team",
"definition" : "http://hl7.org/fhir/SearchParameter/Claim-care-team",
"type" : "reference",
"documentation" : "Member of the CareTeam"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Claim-identifier",
"type" : "token",
"documentation" : "The primary identifier of the financial resource"
},
{
"name" : "use",
"definition" : "http://hl7.org/fhir/SearchParameter/Claim-use",
"type" : "token",
"documentation" : "The kind of financial resource"
},
{
"name" : "created",
"definition" : "http://hl7.org/fhir/SearchParameter/Claim-created",
"type" : "date",
"documentation" : "The creation date for the Claim"
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/Claim-encounter",
"type" : "reference",
"documentation" : "Encounters associated with a billed line item"
},
{
"name" : "priority",
"definition" : "http://hl7.org/fhir/SearchParameter/Claim-priority",
"type" : "token",
"documentation" : "Processing priority requested"
},
{
"name" : "payee",
"definition" : "http://hl7.org/fhir/SearchParameter/Claim-payee",
"type" : "reference",
"documentation" : "The party receiving any payment for the Claim"
},
{
"name" : "provider",
"definition" : "http://hl7.org/fhir/SearchParameter/Claim-provider",
"type" : "reference",
"documentation" : "Provider responsible for the Claim"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/Claim-patient",
"type" : "reference",
"documentation" : "Patient receiving the products or services"
},
{
"name" : "insurer",
"definition" : "http://hl7.org/fhir/SearchParameter/Claim-insurer",
"type" : "reference",
"documentation" : "The target payor/insurer for the Claim"
},
{
"name" : "detail-udi",
"definition" : "http://hl7.org/fhir/SearchParameter/Claim-detail-udi",
"type" : "reference",
"documentation" : "UDI associated with a line item, detail product or service"
},
{
"name" : "enterer",
"definition" : "http://hl7.org/fhir/SearchParameter/Claim-enterer",
"type" : "reference",
"documentation" : "The party responsible for the entry of the Claim"
},
{
"name" : "procedure-udi",
"definition" : "http://hl7.org/fhir/SearchParameter/Claim-procedure-udi",
"type" : "reference",
"documentation" : "UDI associated with a procedure"
},
{
"name" : "subdetail-udi",
"definition" : "http://hl7.org/fhir/SearchParameter/Claim-subdetail-udi",
"type" : "reference",
"documentation" : "UDI associated with a line item, detail, subdetail product or service"
},
{
"name" : "facility",
"definition" : "http://hl7.org/fhir/SearchParameter/Claim-facility",
"type" : "reference",
"documentation" : "Facility where the products or services have been or will be provided"
},
{
"name" : "item-udi",
"definition" : "http://hl7.org/fhir/SearchParameter/Claim-item-udi",
"type" : "reference",
"documentation" : "UDI associated with a line item product or service"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Claim-status",
"type" : "token",
"documentation" : "The status of the Claim instance."
}]
},
{
"type" : "ClaimResponse",
"profile" : "http://hl7.org/fhir/StructureDefinition/ClaimResponse",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["ClaimResponse.request",
"ClaimResponse.insurer",
"ClaimResponse.patient",
"ClaimResponse.requestor"],
"searchRevInclude" : ["DeviceRequest.insurance"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/ClaimResponse-identifier",
"type" : "token",
"documentation" : "The identity of the ClaimResponse"
},
{
"name" : "request",
"definition" : "http://hl7.org/fhir/SearchParameter/ClaimResponse-request",
"type" : "reference",
"documentation" : "The claim reference"
},
{
"name" : "disposition",
"definition" : "http://hl7.org/fhir/SearchParameter/ClaimResponse-disposition",
"type" : "string",
"documentation" : "The contents of the disposition message"
},
{
"name" : "insurer",
"definition" : "http://hl7.org/fhir/SearchParameter/ClaimResponse-insurer",
"type" : "reference",
"documentation" : "The organization which generated this resource"
},
{
"name" : "created",
"definition" : "http://hl7.org/fhir/SearchParameter/ClaimResponse-created",
"type" : "date",
"documentation" : "The creation date"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/ClaimResponse-patient",
"type" : "reference",
"documentation" : "The subject of care"
},
{
"name" : "use",
"definition" : "http://hl7.org/fhir/SearchParameter/ClaimResponse-use",
"type" : "token",
"documentation" : "The type of claim"
},
{
"name" : "payment-date",
"definition" : "http://hl7.org/fhir/SearchParameter/ClaimResponse-payment-date",
"type" : "date",
"documentation" : "The expected payment date"
},
{
"name" : "outcome",
"definition" : "http://hl7.org/fhir/SearchParameter/ClaimResponse-outcome",
"type" : "token",
"documentation" : "The processing outcome"
},
{
"name" : "requestor",
"definition" : "http://hl7.org/fhir/SearchParameter/ClaimResponse-requestor",
"type" : "reference",
"documentation" : "The Provider of the claim"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/ClaimResponse-status",
"type" : "token",
"documentation" : "The status of the ClaimResponse"
}]
},
{
"type" : "ClinicalImpression",
"profile" : "http://hl7.org/fhir/StructureDefinition/ClinicalImpression",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["ClinicalImpression.previous",
"ClinicalImpression.assessor",
"ClinicalImpression.subject",
"ClinicalImpression.encounter",
"ClinicalImpression.finding-ref",
"ClinicalImpression.problem",
"ClinicalImpression.patient",
"ClinicalImpression.supporting-info",
"ClinicalImpression.investigation"],
"searchRevInclude" : ["ClinicalImpression.previous"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "When the assessment was documented"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/ClinicalImpression-identifier",
"type" : "token",
"documentation" : "Business identifier"
},
{
"name" : "previous",
"definition" : "http://hl7.org/fhir/SearchParameter/ClinicalImpression-previous",
"type" : "reference",
"documentation" : "Reference to last assessment"
},
{
"name" : "finding-code",
"definition" : "http://hl7.org/fhir/SearchParameter/ClinicalImpression-finding-code",
"type" : "token",
"documentation" : "What was found"
},
{
"name" : "assessor",
"definition" : "http://hl7.org/fhir/SearchParameter/ClinicalImpression-assessor",
"type" : "reference",
"documentation" : "The clinician performing the assessment"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/ClinicalImpression-subject",
"type" : "reference",
"documentation" : "Patient or group assessed"
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/ClinicalImpression-encounter",
"type" : "reference",
"documentation" : "Encounter created as part of"
},
{
"name" : "finding-ref",
"definition" : "http://hl7.org/fhir/SearchParameter/ClinicalImpression-finding-ref",
"type" : "reference",
"documentation" : "What was found"
},
{
"name" : "problem",
"definition" : "http://hl7.org/fhir/SearchParameter/ClinicalImpression-problem",
"type" : "reference",
"documentation" : "Relevant impressions of patient state"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Patient or group assessed"
},
{
"name" : "supporting-info",
"definition" : "http://hl7.org/fhir/SearchParameter/ClinicalImpression-supporting-info",
"type" : "reference",
"documentation" : "Information supporting the clinical impression"
},
{
"name" : "investigation",
"definition" : "http://hl7.org/fhir/SearchParameter/ClinicalImpression-investigation",
"type" : "reference",
"documentation" : "Record of a specific investigation"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/ClinicalImpression-status",
"type" : "token",
"documentation" : "draft | completed | entered-in-error"
}]
},
{
"type" : "CodeSystem",
"profile" : "http://hl7.org/fhir/StructureDefinition/CodeSystem",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["CodeSystem.supplements"],
"searchRevInclude" : ["CodeSystem.supplements"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-date",
"type" : "date",
"documentation" : "The code system publication date"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-identifier",
"type" : "token",
"documentation" : "External identifier for the code system"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/CodeSystem-code",
"type" : "token",
"documentation" : "A code defined in the code system"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the code system"
},
{
"name" : "content-mode",
"definition" : "http://hl7.org/fhir/SearchParameter/CodeSystem-content-mode",
"type" : "token",
"documentation" : "not-present | example | fragment | complete | supplement"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the code system"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-description",
"type" : "string",
"documentation" : "The description of the code system"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the code system"
},
{
"name" : "language",
"definition" : "http://hl7.org/fhir/SearchParameter/CodeSystem-language",
"type" : "token",
"documentation" : "A language in which a designation is provided"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-title",
"type" : "string",
"documentation" : "The human-friendly name of the code system"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-version",
"type" : "token",
"documentation" : "The business version of the code system"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-url",
"type" : "uri",
"documentation" : "The uri that identifies the code system"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the code system"
},
{
"name" : "supplements",
"definition" : "http://hl7.org/fhir/SearchParameter/CodeSystem-supplements",
"type" : "reference",
"documentation" : "Find code system supplements for the referenced code system"
},
{
"name" : "system",
"definition" : "http://hl7.org/fhir/SearchParameter/CodeSystem-system",
"type" : "uri",
"documentation" : "The system for any codes defined by this code system (same as 'url')"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-name",
"type" : "string",
"documentation" : "Computationally friendly name of the code system"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context",
"type" : "token",
"documentation" : "A use context assigned to the code system"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the code system"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the code system"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-status",
"type" : "token",
"documentation" : "The current status of the code system"
}]
},
{
"type" : "Communication",
"profile" : "http://hl7.org/fhir/StructureDefinition/Communication",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Communication.subject",
"Communication.instantiates-canonical",
"Communication.part-of",
"Communication.encounter",
"Communication.based-on",
"Communication.sender",
"Communication.patient",
"Communication.recipient"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Communication-identifier",
"type" : "token",
"documentation" : "Unique identifier"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/Communication-subject",
"type" : "reference",
"documentation" : "Focus of message"
},
{
"name" : "instantiates-canonical",
"definition" : "http://hl7.org/fhir/SearchParameter/Communication-instantiates-canonical",
"type" : "reference",
"documentation" : "Instantiates FHIR protocol or definition"
},
{
"name" : "received",
"definition" : "http://hl7.org/fhir/SearchParameter/Communication-received",
"type" : "date",
"documentation" : "When received"
},
{
"name" : "part-of",
"definition" : "http://hl7.org/fhir/SearchParameter/Communication-part-of",
"type" : "reference",
"documentation" : "Part of this action"
},
{
"name" : "medium",
"definition" : "http://hl7.org/fhir/SearchParameter/Communication-medium",
"type" : "token",
"documentation" : "A channel of communication"
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/Communication-encounter",
"type" : "reference",
"documentation" : "Encounter created as part of"
},
{
"name" : "sent",
"definition" : "http://hl7.org/fhir/SearchParameter/Communication-sent",
"type" : "date",
"documentation" : "When sent"
},
{
"name" : "based-on",
"definition" : "http://hl7.org/fhir/SearchParameter/Communication-based-on",
"type" : "reference",
"documentation" : "Request fulfilled by this communication"
},
{
"name" : "sender",
"definition" : "http://hl7.org/fhir/SearchParameter/Communication-sender",
"type" : "reference",
"documentation" : "Message sender"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/Communication-patient",
"type" : "reference",
"documentation" : "Focus of message"
},
{
"name" : "recipient",
"definition" : "http://hl7.org/fhir/SearchParameter/Communication-recipient",
"type" : "reference",
"documentation" : "Message recipient"
},
{
"name" : "instantiates-uri",
"definition" : "http://hl7.org/fhir/SearchParameter/Communication-instantiates-uri",
"type" : "uri",
"documentation" : "Instantiates external protocol or definition"
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Communication-category",
"type" : "token",
"documentation" : "Message category"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Communication-status",
"type" : "token",
"documentation" : "preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error"
}]
},
{
"type" : "CommunicationRequest",
"profile" : "http://hl7.org/fhir/StructureDefinition/CommunicationRequest",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["CommunicationRequest.requester",
"CommunicationRequest.subject",
"CommunicationRequest.replaces",
"CommunicationRequest.encounter",
"CommunicationRequest.based-on",
"CommunicationRequest.sender",
"CommunicationRequest.patient",
"CommunicationRequest.recipient"],
"searchRevInclude" : ["CarePlan.activity-reference",
"CommunicationRequest.replaces"],
"searchParam" : [{
"name" : "requester",
"definition" : "http://hl7.org/fhir/SearchParameter/CommunicationRequest-requester",
"type" : "reference",
"documentation" : "Who/what is requesting service"
},
{
"name" : "authored",
"definition" : "http://hl7.org/fhir/SearchParameter/CommunicationRequest-authored",
"type" : "date",
"documentation" : "When request transitioned to being actionable"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/CommunicationRequest-identifier",
"type" : "token",
"documentation" : "Unique identifier"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/CommunicationRequest-subject",
"type" : "reference",
"documentation" : "Focus of message"
},
{
"name" : "replaces",
"definition" : "http://hl7.org/fhir/SearchParameter/CommunicationRequest-replaces",
"type" : "reference",
"documentation" : "Request(s) replaced by this request"
},
{
"name" : "medium",
"definition" : "http://hl7.org/fhir/SearchParameter/CommunicationRequest-medium",
"type" : "token",
"documentation" : "A channel of communication"
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/CommunicationRequest-encounter",
"type" : "reference",
"documentation" : "Encounter created as part of"
},
{
"name" : "occurrence",
"definition" : "http://hl7.org/fhir/SearchParameter/CommunicationRequest-occurrence",
"type" : "date",
"documentation" : "When scheduled"
},
{
"name" : "priority",
"definition" : "http://hl7.org/fhir/SearchParameter/CommunicationRequest-priority",
"type" : "token",
"documentation" : "Message urgency"
},
{
"name" : "group-identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/CommunicationRequest-group-identifier",
"type" : "token",
"documentation" : "Composite request this is part of"
},
{
"name" : "based-on",
"definition" : "http://hl7.org/fhir/SearchParameter/CommunicationRequest-based-on",
"type" : "reference",
"documentation" : "Fulfills plan or proposal"
},
{
"name" : "sender",
"definition" : "http://hl7.org/fhir/SearchParameter/CommunicationRequest-sender",
"type" : "reference",
"documentation" : "Message sender"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/CommunicationRequest-patient",
"type" : "reference",
"documentation" : "Focus of message"
},
{
"name" : "recipient",
"definition" : "http://hl7.org/fhir/SearchParameter/CommunicationRequest-recipient",
"type" : "reference",
"documentation" : "Message recipient"
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/CommunicationRequest-category",
"type" : "token",
"documentation" : "Message category"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/CommunicationRequest-status",
"type" : "token",
"documentation" : "draft | active | suspended | cancelled | completed | entered-in-error | unknown"
}]
},
{
"type" : "CompartmentDefinition",
"profile" : "http://hl7.org/fhir/StructureDefinition/CompartmentDefinition",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-date",
"type" : "date",
"documentation" : "The compartment definition publication date"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/CompartmentDefinition-code",
"type" : "token",
"documentation" : "Patient | Encounter | RelatedPerson | Practitioner | Device"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the compartment definition"
},
{
"name" : "resource",
"definition" : "http://hl7.org/fhir/SearchParameter/CompartmentDefinition-resource",
"type" : "token",
"documentation" : "Name of resource type"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-description",
"type" : "string",
"documentation" : "The description of the compartment definition"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the compartment definition"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-version",
"type" : "token",
"documentation" : "The business version of the compartment definition"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-url",
"type" : "uri",
"documentation" : "The uri that identifies the compartment definition"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the compartment definition"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-name",
"type" : "string",
"documentation" : "Computationally friendly name of the compartment definition"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context",
"type" : "token",
"documentation" : "A use context assigned to the compartment definition"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the compartment definition"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the compartment definition"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-status",
"type" : "token",
"documentation" : "The current status of the compartment definition"
}]
},
{
"type" : "Composition",
"profile" : "http://hl7.org/fhir/StructureDefinition/Composition",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Composition.subject",
"Composition.author",
"Composition.encounter",
"Composition.attester",
"Composition.entry",
"Composition.related-ref",
"Composition.patient"],
"searchRevInclude" : ["Composition.related-ref"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "Composition editing time"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "Version-independent identifier for the Composition"
},
{
"name" : "period",
"definition" : "http://hl7.org/fhir/SearchParameter/Composition-period",
"type" : "date",
"documentation" : "The period covered by the documentation"
},
{
"name" : "related-id",
"definition" : "http://hl7.org/fhir/SearchParameter/Composition-related-id",
"type" : "token",
"documentation" : "Target of the relationship"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/Composition-subject",
"type" : "reference",
"documentation" : "Who and/or what the composition is about"
},
{
"name" : "author",
"definition" : "http://hl7.org/fhir/SearchParameter/Composition-author",
"type" : "reference",
"documentation" : "Who and/or what authored the composition"
},
{
"name" : "confidentiality",
"definition" : "http://hl7.org/fhir/SearchParameter/Composition-confidentiality",
"type" : "token",
"documentation" : "As defined by affinity domain"
},
{
"name" : "section",
"definition" : "http://hl7.org/fhir/SearchParameter/Composition-section",
"type" : "token",
"documentation" : "Classification of section (recommended)"
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type" : "reference",
"documentation" : "Context of the Composition"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-type",
"type" : "token",
"documentation" : "Kind of composition (LOINC if possible)"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/Composition-title",
"type" : "string",
"documentation" : "Human Readable name/title"
},
{
"name" : "attester",
"definition" : "http://hl7.org/fhir/SearchParameter/Composition-attester",
"type" : "reference",
"documentation" : "Who attested the composition"
},
{
"name" : "entry",
"definition" : "http://hl7.org/fhir/SearchParameter/Composition-entry",
"type" : "reference",
"documentation" : "A reference to data that supports this section"
},
{
"name" : "related-ref",
"definition" : "http://hl7.org/fhir/SearchParameter/Composition-related-ref",
"type" : "reference",
"documentation" : "Target of the relationship"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Who and/or what the composition is about"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/Composition-context",
"type" : "token",
"documentation" : "Code(s) that apply to the event being documented"
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Composition-category",
"type" : "token",
"documentation" : "Categorization of Composition"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Composition-status",
"type" : "token",
"documentation" : "preliminary | final | amended | entered-in-error"
}]
},
{
"type" : "ConceptMap",
"profile" : "http://hl7.org/fhir/StructureDefinition/ConceptMap",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["ConceptMap.other",
"ConceptMap.source",
"ConceptMap.source-uri",
"ConceptMap.target-uri",
"ConceptMap.target"],
"searchRevInclude" : ["ConceptMap.other"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-date",
"type" : "date",
"documentation" : "The concept map publication date"
},
{
"name" : "other",
"definition" : "http://hl7.org/fhir/SearchParameter/ConceptMap-other",
"type" : "reference",
"documentation" : "canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the concept map"
},
{
"name" : "target-system",
"definition" : "http://hl7.org/fhir/SearchParameter/ConceptMap-target-system",
"type" : "uri",
"documentation" : "Target system that the concepts are to be mapped to"
},
{
"name" : "dependson",
"definition" : "http://hl7.org/fhir/SearchParameter/ConceptMap-dependson",
"type" : "uri",
"documentation" : "Reference to property mapping depends on"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the concept map"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-description",
"type" : "string",
"documentation" : "The description of the concept map"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the concept map"
},
{
"name" : "source",
"definition" : "http://hl7.org/fhir/SearchParameter/ConceptMap-source",
"type" : "reference",
"documentation" : "The source value set that contains the concepts that are being mapped"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-title",
"type" : "string",
"documentation" : "The human-friendly name of the concept map"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the concept map"
},
{
"name" : "source-uri",
"definition" : "http://hl7.org/fhir/SearchParameter/ConceptMap-source-uri",
"type" : "reference",
"documentation" : "The source value set that contains the concepts that are being mapped"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context",
"type" : "token",
"documentation" : "A use context assigned to the concept map"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the concept map"
},
{
"name" : "source-system",
"definition" : "http://hl7.org/fhir/SearchParameter/ConceptMap-source-system",
"type" : "uri",
"documentation" : "Source system where concepts to be mapped are defined"
},
{
"name" : "target-code",
"definition" : "http://hl7.org/fhir/SearchParameter/ConceptMap-target-code",
"type" : "token",
"documentation" : "Code that identifies the target element"
},
{
"name" : "target-uri",
"definition" : "http://hl7.org/fhir/SearchParameter/ConceptMap-target-uri",
"type" : "reference",
"documentation" : "The target value set which provides context for the mappings"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-identifier",
"type" : "token",
"documentation" : "External identifier for the concept map"
},
{
"name" : "product",
"definition" : "http://hl7.org/fhir/SearchParameter/ConceptMap-product",
"type" : "uri",
"documentation" : "Reference to property mapping depends on"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-version",
"type" : "token",
"documentation" : "The business version of the concept map"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-url",
"type" : "uri",
"documentation" : "The uri that identifies the concept map"
},
{
"name" : "target",
"definition" : "http://hl7.org/fhir/SearchParameter/ConceptMap-target",
"type" : "reference",
"documentation" : "The target value set which provides context for the mappings"
},
{
"name" : "source-code",
"definition" : "http://hl7.org/fhir/SearchParameter/ConceptMap-source-code",
"type" : "token",
"documentation" : "Identifies element being mapped"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-name",
"type" : "string",
"documentation" : "Computationally friendly name of the concept map"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the concept map"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-status",
"type" : "token",
"documentation" : "The current status of the concept map"
}]
},
{
"type" : "Condition",
"profile" : "http://hl7.org/fhir/StructureDefinition/Condition",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Condition.evidence-detail",
"Condition.subject",
"Condition.encounter",
"Condition.asserter",
"Condition.patient"],
"searchRevInclude" : ["AdverseEvent.resultingcondition",
"Appointment.reason-reference",
"CarePlan.condition",
"ClinicalImpression.finding-ref",
"ClinicalImpression.problem",
"Encounter.diagnosis",
"Encounter.reason-reference",
"EpisodeOfCare.condition",
"Immunization.reason-reference",
"Procedure.reason-reference",
"RiskAssessment.condition"],
"searchParam" : [{
"name" : "severity",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-severity",
"type" : "token",
"documentation" : "The severity of the condition"
},
{
"name" : "evidence-detail",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-evidence-detail",
"type" : "reference",
"documentation" : "Supporting information found elsewhere"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "A unique identifier of the condition record"
},
{
"name" : "onset-info",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-onset-info",
"type" : "string",
"documentation" : "Onsets as a string"
},
{
"name" : "recorded-date",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-recorded-date",
"type" : "date",
"documentation" : "Date record was first recorded"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "Code for the condition"
},
{
"name" : "evidence",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-evidence",
"type" : "token",
"documentation" : "Manifestation/symptom"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-subject",
"type" : "reference",
"documentation" : "Who has the condition?"
},
{
"name" : "verification-status",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-verification-status",
"type" : "token",
"documentation" : "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error"
},
{
"name" : "clinical-status",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-clinical-status",
"type" : "token",
"documentation" : "The clinical status of the condition"
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-encounter",
"type" : "reference",
"documentation" : "Encounter created as part of"
},
{
"name" : "onset-date",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-onset-date",
"type" : "date",
"documentation" : "Date related onsets (dateTime and Period)"
},
{
"name" : "abatement-date",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-abatement-date",
"type" : "date",
"documentation" : "Date-related abatements (dateTime and period)"
},
{
"name" : "asserter",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-asserter",
"type" : "reference",
"documentation" : "Person who asserts this condition"
},
{
"name" : "stage",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-stage",
"type" : "token",
"documentation" : "Simple summary (disease specific)"
},
{
"name" : "abatement-string",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-abatement-string",
"type" : "string",
"documentation" : "Abatement as a string"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Who has the condition?"
},
{
"name" : "onset-age",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-onset-age",
"type" : "quantity",
"documentation" : "Onsets as age or age range"
},
{
"name" : "abatement-age",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-abatement-age",
"type" : "quantity",
"documentation" : "Abatement as age or age range"
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-category",
"type" : "token",
"documentation" : "The category of the condition"
},
{
"name" : "body-site",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-body-site",
"type" : "token",
"documentation" : "Anatomical location, if relevant"
}]
},
{
"type" : "Consent",
"profile" : "http://hl7.org/fhir/StructureDefinition/Consent",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Consent.data",
"Consent.source-reference",
"Consent.actor",
"Consent.patient",
"Consent.organization",
"Consent.consentor"],
"searchRevInclude" : ["Consent.source-reference"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "When this Consent was created or indexed"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "Identifier for this record (external references)"
},
{
"name" : "period",
"definition" : "http://hl7.org/fhir/SearchParameter/Consent-period",
"type" : "date",
"documentation" : "Timeframe for this rule"
},
{
"name" : "data",
"definition" : "http://hl7.org/fhir/SearchParameter/Consent-data",
"type" : "reference",
"documentation" : "The actual data reference"
},
{
"name" : "purpose",
"definition" : "http://hl7.org/fhir/SearchParameter/Consent-purpose",
"type" : "token",
"documentation" : "Context of activities covered by this rule"
},
{
"name" : "source-reference",
"definition" : "http://hl7.org/fhir/SearchParameter/Consent-source-reference",
"type" : "reference",
"documentation" : "Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse"
},
{
"name" : "actor",
"definition" : "http://hl7.org/fhir/SearchParameter/Consent-actor",
"type" : "reference",
"documentation" : "Resource for the actor (or group, by role)"
},
{
"name" : "security-label",
"definition" : "http://hl7.org/fhir/SearchParameter/Consent-security-label",
"type" : "token",
"documentation" : "Security Labels that define affected resources"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Who the consent applies to"
},
{
"name" : "organization",
"definition" : "http://hl7.org/fhir/SearchParameter/Consent-organization",
"type" : "reference",
"documentation" : "Custodian of the consent"
},
{
"name" : "scope",
"definition" : "http://hl7.org/fhir/SearchParameter/Consent-scope",
"type" : "token",
"documentation" : "Which of the four areas this resource covers (extensible)"
},
{
"name" : "action",
"definition" : "http://hl7.org/fhir/SearchParameter/Consent-action",
"type" : "token",
"documentation" : "Actions controlled by this rule"
},
{
"name" : "consentor",
"definition" : "http://hl7.org/fhir/SearchParameter/Consent-consentor",
"type" : "reference",
"documentation" : "Who is agreeing to the policy and rules"
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Consent-category",
"type" : "token",
"documentation" : "Classification of the consent statement - for indexing/retrieval"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Consent-status",
"type" : "token",
"documentation" : "draft | proposed | active | rejected | inactive | entered-in-error"
}]
},
{
"type" : "Contract",
"profile" : "http://hl7.org/fhir/StructureDefinition/Contract",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Contract.patient",
"Contract.subject",
"Contract.authority",
"Contract.domain",
"Contract.signer"],
"searchRevInclude" : ["Consent.source-reference"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Contract-identifier",
"type" : "token",
"documentation" : "The identity of the contract"
},
{
"name" : "instantiates",
"definition" : "http://hl7.org/fhir/SearchParameter/Contract-instantiates",
"type" : "uri",
"documentation" : "A source definition of the contract"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/Contract-patient",
"type" : "reference",
"documentation" : "The identity of the subject of the contract (if a patient)"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/Contract-subject",
"type" : "reference",
"documentation" : "The identity of the subject of the contract"
},
{
"name" : "authority",
"definition" : "http://hl7.org/fhir/SearchParameter/Contract-authority",
"type" : "reference",
"documentation" : "The authority of the contract"
},
{
"name" : "domain",
"definition" : "http://hl7.org/fhir/SearchParameter/Contract-domain",
"type" : "reference",
"documentation" : "The domain of the contract"
},
{
"name" : "issued",
"definition" : "http://hl7.org/fhir/SearchParameter/Contract-issued",
"type" : "date",
"documentation" : "The date/time the contract was issued"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/Contract-url",
"type" : "uri",
"documentation" : "The basal contract definition"
},
{
"name" : "signer",
"definition" : "http://hl7.org/fhir/SearchParameter/Contract-signer",
"type" : "reference",
"documentation" : "Contract Signatory Party"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Contract-status",
"type" : "token",
"documentation" : "The status of the contract"
}]
},
{
"type" : "Coverage",
"profile" : "http://hl7.org/fhir/StructureDefinition/Coverage",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Coverage.payor",
"Coverage.subscriber",
"Coverage.beneficiary",
"Coverage.patient",
"Coverage.policy-holder"],
"searchRevInclude" : ["DeviceRequest.insurance",
"ExplanationOfBenefit.coverage"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Coverage-identifier",
"type" : "token",
"documentation" : "The primary identifier of the insured and the coverage"
},
{
"name" : "payor",
"definition" : "http://hl7.org/fhir/SearchParameter/Coverage-payor",
"type" : "reference",
"documentation" : "The identity of the insurer or party paying for services"
},
{
"name" : "subscriber",
"definition" : "http://hl7.org/fhir/SearchParameter/Coverage-subscriber",
"type" : "reference",
"documentation" : "Reference to the subscriber"
},
{
"name" : "beneficiary",
"definition" : "http://hl7.org/fhir/SearchParameter/Coverage-beneficiary",
"type" : "reference",
"documentation" : "Covered party"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/Coverage-patient",
"type" : "reference",
"documentation" : "Retrieve coverages for a patient"
},
{
"name" : "class-value",
"definition" : "http://hl7.org/fhir/SearchParameter/Coverage-class-value",
"type" : "string",
"documentation" : "Value of the class (eg. Plan number, group number)"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/Coverage-type",
"type" : "token",
"documentation" : "The kind of coverage (health plan, auto, Workers Compensation)"
},
{
"name" : "dependent",
"definition" : "http://hl7.org/fhir/SearchParameter/Coverage-dependent",
"type" : "string",
"documentation" : "Dependent number"
},
{
"name" : "class-type",
"definition" : "http://hl7.org/fhir/SearchParameter/Coverage-class-type",
"type" : "token",
"documentation" : "Coverage class (eg. plan, group)"
},
{
"name" : "policy-holder",
"definition" : "http://hl7.org/fhir/SearchParameter/Coverage-policy-holder",
"type" : "reference",
"documentation" : "Reference to the policyholder"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Coverage-status",
"type" : "token",
"documentation" : "The status of the Coverage"
}]
},
{
"type" : "CoverageEligibilityRequest",
"profile" : "http://hl7.org/fhir/StructureDefinition/CoverageEligibilityRequest",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["CoverageEligibilityRequest.provider",
"CoverageEligibilityRequest.patient",
"CoverageEligibilityRequest.enterer",
"CoverageEligibilityRequest.facility"],
"searchRevInclude" : ["CoverageEligibilityResponse.request"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/CoverageEligibilityRequest-identifier",
"type" : "token",
"documentation" : "The business identifier of the Eligibility"
},
{
"name" : "provider",
"definition" : "http://hl7.org/fhir/SearchParameter/CoverageEligibilityRequest-provider",
"type" : "reference",
"documentation" : "The reference to the provider"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/CoverageEligibilityRequest-patient",
"type" : "reference",
"documentation" : "The reference to the patient"
},
{
"name" : "created",
"definition" : "http://hl7.org/fhir/SearchParameter/CoverageEligibilityRequest-created",
"type" : "date",
"documentation" : "The creation date for the EOB"
},
{
"name" : "enterer",
"definition" : "http://hl7.org/fhir/SearchParameter/CoverageEligibilityRequest-enterer",
"type" : "reference",
"documentation" : "The party who is responsible for the request"
},
{
"name" : "facility",
"definition" : "http://hl7.org/fhir/SearchParameter/CoverageEligibilityRequest-facility",
"type" : "reference",
"documentation" : "Facility responsible for the goods and services"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/CoverageEligibilityRequest-status",
"type" : "token",
"documentation" : "The status of the EligibilityRequest"
}]
},
{
"type" : "CoverageEligibilityResponse",
"profile" : "http://hl7.org/fhir/StructureDefinition/CoverageEligibilityResponse",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["CoverageEligibilityResponse.request",
"CoverageEligibilityResponse.patient",
"CoverageEligibilityResponse.insurer",
"CoverageEligibilityResponse.requestor"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/CoverageEligibilityResponse-identifier",
"type" : "token",
"documentation" : "The business identifier"
},
{
"name" : "request",
"definition" : "http://hl7.org/fhir/SearchParameter/CoverageEligibilityResponse-request",
"type" : "reference",
"documentation" : "The EligibilityRequest reference"
},
{
"name" : "disposition",
"definition" : "http://hl7.org/fhir/SearchParameter/CoverageEligibilityResponse-disposition",
"type" : "string",
"documentation" : "The contents of the disposition message"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/CoverageEligibilityResponse-patient",
"type" : "reference",
"documentation" : "The reference to the patient"
},
{
"name" : "insurer",
"definition" : "http://hl7.org/fhir/SearchParameter/CoverageEligibilityResponse-insurer",
"type" : "reference",
"documentation" : "The organization which generated this resource"
},
{
"name" : "created",
"definition" : "http://hl7.org/fhir/SearchParameter/CoverageEligibilityResponse-created",
"type" : "date",
"documentation" : "The creation date"
},
{
"name" : "outcome",
"definition" : "http://hl7.org/fhir/SearchParameter/CoverageEligibilityResponse-outcome",
"type" : "token",
"documentation" : "The processing outcome"
},
{
"name" : "requestor",
"definition" : "http://hl7.org/fhir/SearchParameter/CoverageEligibilityResponse-requestor",
"type" : "reference",
"documentation" : "The EligibilityRequest provider"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/CoverageEligibilityResponse-status",
"type" : "token",
"documentation" : "The EligibilityRequest status"
}]
},
{
"type" : "DetectedIssue",
"profile" : "http://hl7.org/fhir/StructureDefinition/DetectedIssue",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["DetectedIssue.patient",
"DetectedIssue.author",
"DetectedIssue.implicated"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "Unique id for the detected issue"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/DetectedIssue-code",
"type" : "token",
"documentation" : "Issue Category, e.g. drug-drug, duplicate therapy, etc."
},
{
"name" : "identified",
"definition" : "http://hl7.org/fhir/SearchParameter/DetectedIssue-identified",
"type" : "date",
"documentation" : "When identified"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Associated patient"
},
{
"name" : "author",
"definition" : "http://hl7.org/fhir/SearchParameter/DetectedIssue-author",
"type" : "reference",
"documentation" : "The provider or device that identified the issue"
},
{
"name" : "implicated",
"definition" : "http://hl7.org/fhir/SearchParameter/DetectedIssue-implicated",
"type" : "reference",
"documentation" : "Problem resource"
}]
},
{
"type" : "Device",
"profile" : "http://hl7.org/fhir/StructureDefinition/Device",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Device.patient",
"Device.organization",
"Device.location"],
"searchRevInclude" : ["Account.subject",
"Account.patient",
"AdverseEvent.substance",
"Appointment.practitioner",
"Appointment.actor",
"Appointment.patient",
"Appointment.location",
"AppointmentResponse.actor",
"AppointmentResponse.practitioner",
"AppointmentResponse.patient",
"AppointmentResponse.location",
"AuditEvent.agent",
"AuditEvent.source",
"AuditEvent.patient",
"CarePlan.performer",
"ChargeItem.enterer",
"ChargeItem.performer-actor",
"Claim.detail-udi",
"Claim.procedure-udi",
"Claim.subdetail-udi",
"Claim.item-udi",
"Communication.sender",
"Communication.recipient",
"CommunicationRequest.requester",
"CommunicationRequest.sender",
"CommunicationRequest.recipient",
"Composition.author",
"Consent.actor",
"DetectedIssue.author",
"DeviceMetric.parent",
"DeviceMetric.source",
"DeviceRequest.requester",
"DeviceRequest.performer",
"DeviceRequest.subject",
"DeviceRequest.patient",
"DeviceRequest.device",
"DeviceUseStatement.device",
"DiagnosticReport.subject",
"DiagnosticReport.patient",
"DocumentManifest.subject",
"DocumentManifest.author",
"DocumentManifest.patient",
"DocumentReference.subject",
"DocumentReference.patient",
"DocumentReference.author",
"ExplanationOfBenefit.detail-udi",
"ExplanationOfBenefit.procedure-udi",
"ExplanationOfBenefit.subdetail-udi",
"ExplanationOfBenefit.item-udi",
"Flag.author",
"Group.member",
"ImagingStudy.performer",
"ImagingStudy.subject",
"ImagingStudy.patient",
"Invoice.participant",
"List.subject",
"List.patient",
"List.source",
"MeasureReport.patient",
"MeasureReport.subject",
"Media.subject",
"Media.operator",
"Media.patient",
"Media.device",
"MedicationAdministration.performer",
"MedicationAdministration.device",
"MedicationDispense.performer",
"MedicationRequest.requester",
"MedicationRequest.intended-performer",
"MessageHeader.target",
"Observation.subject",
"Observation.patient",
"Observation.device",
"Procedure.performer",
"Provenance.agent",
"QuestionnaireResponse.author",
"RequestGroup.author",
"RequestGroup.participant",
"RiskAssessment.performer",
"Schedule.actor",
"ServiceRequest.requester",
"ServiceRequest.performer",
"ServiceRequest.subject",
"ServiceRequest.patient",
"Specimen.subject",
"Specimen.patient",
"SupplyRequest.requester",
"Task.owner",
"Task.requester"],
"searchParam" : [{
"name" : "udi-di",
"definition" : "http://hl7.org/fhir/SearchParameter/Device-udi-di",
"type" : "string",
"documentation" : "The udi Device Identifier (DI)"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Device-identifier",
"type" : "token",
"documentation" : "Instance id from manufacturer, owner, and others"
},
{
"name" : "udi-carrier",
"definition" : "http://hl7.org/fhir/SearchParameter/Device-udi-carrier",
"type" : "string",
"documentation" : "UDI Barcode (RFID or other technology) string in *HRF* format."
},
{
"name" : "device-name",
"definition" : "http://hl7.org/fhir/SearchParameter/Device-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",
"definition" : "http://hl7.org/fhir/SearchParameter/Device-patient",
"type" : "reference",
"documentation" : "Patient information, if the resource is affixed to a person"
},
{
"name" : "organization",
"definition" : "http://hl7.org/fhir/SearchParameter/Device-organization",
"type" : "reference",
"documentation" : "The organization responsible for the device"
},
{
"name" : "model",
"definition" : "http://hl7.org/fhir/SearchParameter/Device-model",
"type" : "string",
"documentation" : "The model of the device"
},
{
"name" : "location",
"definition" : "http://hl7.org/fhir/SearchParameter/Device-location",
"type" : "reference",
"documentation" : "A location, where the resource is found"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/Device-type",
"type" : "token",
"documentation" : "The type of the device"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/Device-url",
"type" : "uri",
"documentation" : "Network address to contact device"
},
{
"name" : "manufacturer",
"definition" : "http://hl7.org/fhir/SearchParameter/Device-manufacturer",
"type" : "string",
"documentation" : "The manufacturer of the device"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Device-status",
"type" : "token",
"documentation" : "active | inactive | entered-in-error | unknown"
}]
},
{
"type" : "DeviceDefinition",
"profile" : "http://hl7.org/fhir/StructureDefinition/DeviceDefinition",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["DeviceDefinition.parent"],
"searchRevInclude" : ["DeviceDefinition.parent"],
"searchParam" : [{
"name" : "parent",
"definition" : "http://hl7.org/fhir/SearchParameter/DeviceDefinition-parent",
"type" : "reference",
"documentation" : "The parent DeviceDefinition resource"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/DeviceDefinition-identifier",
"type" : "token",
"documentation" : "The identifier of the component"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/DeviceDefinition-type",
"type" : "token",
"documentation" : "The device component type"
}]
},
{
"type" : "DeviceMetric",
"profile" : "http://hl7.org/fhir/StructureDefinition/DeviceMetric",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["DeviceMetric.parent",
"DeviceMetric.source"],
"searchRevInclude" : ["Media.device",
"Observation.device"],
"searchParam" : [{
"name" : "parent",
"definition" : "http://hl7.org/fhir/SearchParameter/DeviceMetric-parent",
"type" : "reference",
"documentation" : "The parent DeviceMetric resource"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/DeviceMetric-identifier",
"type" : "token",
"documentation" : "The identifier of the metric"
},
{
"name" : "source",
"definition" : "http://hl7.org/fhir/SearchParameter/DeviceMetric-source",
"type" : "reference",
"documentation" : "The device resource"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/DeviceMetric-type",
"type" : "token",
"documentation" : "The component type"
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/DeviceMetric-category",
"type" : "token",
"documentation" : "The category of the metric"
}]
},
{
"type" : "DeviceRequest",
"profile" : "http://hl7.org/fhir/StructureDefinition/DeviceRequest",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["DeviceRequest.requester",
"DeviceRequest.insurance",
"DeviceRequest.performer",
"DeviceRequest.subject",
"DeviceRequest.instantiates-canonical",
"DeviceRequest.encounter",
"DeviceRequest.based-on",
"DeviceRequest.patient",
"DeviceRequest.prior-request",
"DeviceRequest.device"],
"searchRevInclude" : ["CarePlan.activity-reference",
"Observation.based-on"],
"searchParam" : [{
"name" : "requester",
"definition" : "http://hl7.org/fhir/SearchParameter/DeviceRequest-requester",
"type" : "reference",
"documentation" : "Who/what is requesting service"
},
{
"name" : "insurance",
"definition" : "http://hl7.org/fhir/SearchParameter/DeviceRequest-insurance",
"type" : "reference",
"documentation" : "Associated insurance coverage"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "Business identifier for request/order"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "Code for what is being requested/ordered"
},
{
"name" : "performer",
"definition" : "http://hl7.org/fhir/SearchParameter/DeviceRequest-performer",
"type" : "reference",
"documentation" : "Desired performer for service"
},
{
"name" : "event-date",
"definition" : "http://hl7.org/fhir/SearchParameter/DeviceRequest-event-date",
"type" : "date",
"documentation" : "When service should occur"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/DeviceRequest-subject",
"type" : "reference",
"documentation" : "Individual the service is ordered for"
},
{
"name" : "instantiates-canonical",
"definition" : "http://hl7.org/fhir/SearchParameter/DeviceRequest-instantiates-canonical",
"type" : "reference",
"documentation" : "Instantiates FHIR protocol or definition"
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type" : "reference",
"documentation" : "Encounter during which request was created"
},
{
"name" : "authored-on",
"definition" : "http://hl7.org/fhir/SearchParameter/DeviceRequest-authored-on",
"type" : "date",
"documentation" : "When the request transitioned to being actionable"
},
{
"name" : "intent",
"definition" : "http://hl7.org/fhir/SearchParameter/DeviceRequest-intent",
"type" : "token",
"documentation" : "proposal | plan | original-order |reflex-order"
},
{
"name" : "group-identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/DeviceRequest-group-identifier",
"type" : "token",
"documentation" : "Composite request this is part of"
},
{
"name" : "based-on",
"definition" : "http://hl7.org/fhir/SearchParameter/DeviceRequest-based-on",
"type" : "reference",
"documentation" : "Plan/proposal/order fulfilled by this request"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Individual the service is ordered for"
},
{
"name" : "instantiates-uri",
"definition" : "http://hl7.org/fhir/SearchParameter/DeviceRequest-instantiates-uri",
"type" : "uri",
"documentation" : "Instantiates external protocol or definition"
},
{
"name" : "prior-request",
"definition" : "http://hl7.org/fhir/SearchParameter/DeviceRequest-prior-request",
"type" : "reference",
"documentation" : "Request takes the place of referenced completed or terminated requests"
},
{
"name" : "device",
"definition" : "http://hl7.org/fhir/SearchParameter/DeviceRequest-device",
"type" : "reference",
"documentation" : "Reference to resource that is being requested/ordered"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/DeviceRequest-status",
"type" : "token",
"documentation" : "entered-in-error | draft | active |suspended | completed"
}]
},
{
"type" : "DeviceUseStatement",
"profile" : "http://hl7.org/fhir/StructureDefinition/DeviceUseStatement",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["DeviceUseStatement.subject",
"DeviceUseStatement.patient",
"DeviceUseStatement.device"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/DeviceUseStatement-identifier",
"type" : "token",
"documentation" : "Search by identifier"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/DeviceUseStatement-subject",
"type" : "reference",
"documentation" : "Search by subject"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Search by subject - a patient"
},
{
"name" : "device",
"definition" : "http://hl7.org/fhir/SearchParameter/DeviceUseStatement-device",
"type" : "reference",
"documentation" : "Search by device"
}]
},
{
"type" : "DiagnosticReport",
"profile" : "http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["DiagnosticReport.performer",
"DiagnosticReport.subject",
"DiagnosticReport.media",
"DiagnosticReport.encounter",
"DiagnosticReport.result",
"DiagnosticReport.based-on",
"DiagnosticReport.patient",
"DiagnosticReport.specimen",
"DiagnosticReport.results-interpreter"],
"searchRevInclude" : ["ChargeItem.service",
"ClinicalImpression.investigation",
"Immunization.reason-reference",
"Procedure.reason-reference"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "The clinically relevant time of the report"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "An identifier for the report"
},
{
"name" : "performer",
"definition" : "http://hl7.org/fhir/SearchParameter/DiagnosticReport-performer",
"type" : "reference",
"documentation" : "Who is responsible for the report"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "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"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/DiagnosticReport-subject",
"type" : "reference",
"documentation" : "The subject of the report"
},
{
"name" : "media",
"definition" : "http://hl7.org/fhir/SearchParameter/DiagnosticReport-media",
"type" : "reference",
"documentation" : "A reference to the image source."
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type" : "reference",
"documentation" : "The Encounter when the order was made"
},
{
"name" : "result",
"definition" : "http://hl7.org/fhir/SearchParameter/DiagnosticReport-result",
"type" : "reference",
"documentation" : "Link to an atomic result (observation resource)"
},
{
"name" : "conclusion",
"definition" : "http://hl7.org/fhir/SearchParameter/DiagnosticReport-conclusion",
"type" : "token",
"documentation" : "A coded conclusion (interpretation/impression) on the report"
},
{
"name" : "based-on",
"definition" : "http://hl7.org/fhir/SearchParameter/DiagnosticReport-based-on",
"type" : "reference",
"documentation" : "Reference to the service request."
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The subject of the report if a patient"
},
{
"name" : "specimen",
"definition" : "http://hl7.org/fhir/SearchParameter/DiagnosticReport-specimen",
"type" : "reference",
"documentation" : "The specimen details"
},
{
"name" : "issued",
"definition" : "http://hl7.org/fhir/SearchParameter/DiagnosticReport-issued",
"type" : "date",
"documentation" : "When the report was issued"
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/DiagnosticReport-category",
"type" : "token",
"documentation" : "Which diagnostic discipline/department created the report"
},
{
"name" : "results-interpreter",
"definition" : "http://hl7.org/fhir/SearchParameter/DiagnosticReport-results-interpreter",
"type" : "reference",
"documentation" : "Who was the source of the report"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/DiagnosticReport-status",
"type" : "token",
"documentation" : "The status of the report"
}]
},
{
"type" : "DocumentManifest",
"profile" : "http://hl7.org/fhir/StructureDefinition/DocumentManifest",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["DocumentManifest.item",
"DocumentManifest.subject",
"DocumentManifest.author",
"DocumentManifest.related-ref",
"DocumentManifest.patient",
"DocumentManifest.recipient"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "Unique Identifier for the set of documents"
},
{
"name" : "item",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentManifest-item",
"type" : "reference",
"documentation" : "Items in manifest"
},
{
"name" : "related-id",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentManifest-related-id",
"type" : "token",
"documentation" : "Identifiers of things that are related"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentManifest-subject",
"type" : "reference",
"documentation" : "The subject of the set of documents"
},
{
"name" : "author",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentManifest-author",
"type" : "reference",
"documentation" : "Who and/or what authored the DocumentManifest"
},
{
"name" : "created",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentManifest-created",
"type" : "date",
"documentation" : "When this document manifest created"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentManifest-description",
"type" : "string",
"documentation" : "Human-readable description (title)"
},
{
"name" : "source",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentManifest-source",
"type" : "uri",
"documentation" : "The source system/application/software"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-type",
"type" : "token",
"documentation" : "Kind of document set"
},
{
"name" : "related-ref",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentManifest-related-ref",
"type" : "reference",
"documentation" : "Related Resource"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The subject of the set of documents"
},
{
"name" : "recipient",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentManifest-recipient",
"type" : "reference",
"documentation" : "Intended to get notified about this set of documents"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentManifest-status",
"type" : "token",
"documentation" : "current | superseded | entered-in-error"
}]
},
{
"type" : "DocumentReference",
"profile" : "http://hl7.org/fhir/StructureDefinition/DocumentReference",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["DocumentReference.subject",
"DocumentReference.related",
"DocumentReference.patient",
"DocumentReference.authenticator",
"DocumentReference.custodian",
"DocumentReference.author",
"DocumentReference.encounter",
"DocumentReference.relatesto"],
"searchRevInclude" : ["Consent.source-reference",
"DocumentReference.relatesto",
"MedicationKnowledge.monograph",
"Observation.derived-from",
"Procedure.reason-reference"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-date",
"type" : "date",
"documentation" : "When this document reference was created"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-subject",
"type" : "reference",
"documentation" : "Who/what is the subject of the document"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-description",
"type" : "string",
"documentation" : "Human-readable description"
},
{
"name" : "language",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-language",
"type" : "token",
"documentation" : "Human language of the content (BCP-47)"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-type",
"type" : "token",
"documentation" : "Kind of document (LOINC if possible)"
},
{
"name" : "relation",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-relation",
"type" : "token",
"documentation" : "replaces | transforms | signs | appends"
},
{
"name" : "setting",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-setting",
"type" : "token",
"documentation" : "Additional details about where the content was created (e.g. clinical specialty)"
},
{
"name" : "related",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-related",
"type" : "reference",
"documentation" : "Related identifiers or resources"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Who/what is the subject of the document"
},
{
"name" : "relationship",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-relationship",
"type" : "composite",
"documentation" : "Combination of relation and relatesTo"
},
{
"name" : "event",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-event",
"type" : "token",
"documentation" : "Main clinical acts documented"
},
{
"name" : "authenticator",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-authenticator",
"type" : "reference",
"documentation" : "Who/what authenticated the document"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "Master Version Specific Identifier"
},
{
"name" : "period",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-period",
"type" : "date",
"documentation" : "Time of service that is being documented"
},
{
"name" : "custodian",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-custodian",
"type" : "reference",
"documentation" : "Organization which maintains the document"
},
{
"name" : "author",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-author",
"type" : "reference",
"documentation" : "Who and/or what authored the document"
},
{
"name" : "format",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-format",
"type" : "token",
"documentation" : "Format/content rules for the document"
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type" : "reference",
"documentation" : "Context of the document content"
},
{
"name" : "contenttype",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-contenttype",
"type" : "token",
"documentation" : "Mime type of the content, with charset etc."
},
{
"name" : "security-label",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-security-label",
"type" : "token",
"documentation" : "Document security-tags"
},
{
"name" : "location",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-location",
"type" : "uri",
"documentation" : "Uri where the data can be found"
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-category",
"type" : "token",
"documentation" : "Categorization of document"
},
{
"name" : "relatesto",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-relatesto",
"type" : "reference",
"documentation" : "Target of the relationship"
},
{
"name" : "facility",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-facility",
"type" : "token",
"documentation" : "Kind of facility where patient was seen"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-status",
"type" : "token",
"documentation" : "current | superseded | entered-in-error"
}]
},
{
"type" : "EffectEvidenceSynthesis",
"profile" : "http://hl7.org/fhir/StructureDefinition/EffectEvidenceSynthesis",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-date",
"type" : "date",
"documentation" : "The effect evidence synthesis publication date"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-identifier",
"type" : "token",
"documentation" : "External identifier for the effect evidence synthesis"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the effect evidence synthesis"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the effect evidence synthesis"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-description",
"type" : "string",
"documentation" : "The description of the effect evidence synthesis"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the effect evidence synthesis"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-title",
"type" : "string",
"documentation" : "The human-friendly name of the effect evidence synthesis"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-version",
"type" : "token",
"documentation" : "The business version of the effect evidence synthesis"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-url",
"type" : "uri",
"documentation" : "The uri that identifies the effect evidence synthesis"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the effect evidence synthesis"
},
{
"name" : "effective",
"definition" : "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-effective",
"type" : "date",
"documentation" : "The time during which the effect evidence synthesis is intended to be in use"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-name",
"type" : "string",
"documentation" : "Computationally friendly name of the effect evidence synthesis"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-context",
"type" : "token",
"documentation" : "A use context assigned to the effect evidence synthesis"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the effect evidence synthesis"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the effect evidence synthesis"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-status",
"type" : "token",
"documentation" : "The current status of the effect evidence synthesis"
}]
},
{
"type" : "Encounter",
"profile" : "http://hl7.org/fhir/StructureDefinition/Encounter",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Encounter.practitioner",
"Encounter.subject",
"Encounter.episode-of-care",
"Encounter.diagnosis",
"Encounter.appointment",
"Encounter.part-of",
"Encounter.participant",
"Encounter.based-on",
"Encounter.patient",
"Encounter.reason-reference",
"Encounter.location",
"Encounter.service-provider",
"Encounter.account"],
"searchRevInclude" : ["CarePlan.encounter",
"CareTeam.encounter",
"ChargeItem.context",
"Claim.encounter",
"ClinicalImpression.encounter",
"Communication.encounter",
"CommunicationRequest.encounter",
"Composition.encounter",
"Condition.encounter",
"DeviceRequest.encounter",
"DiagnosticReport.encounter",
"DocumentReference.encounter",
"Encounter.part-of",
"ExplanationOfBenefit.encounter",
"Flag.encounter",
"ImagingStudy.encounter",
"List.encounter",
"Media.encounter",
"MedicationAdministration.context",
"MedicationDispense.context",
"MedicationRequest.encounter",
"MedicationStatement.context",
"NutritionOrder.encounter",
"Observation.encounter",
"Procedure.encounter",
"QuestionnaireResponse.encounter",
"RequestGroup.encounter",
"RiskAssessment.encounter",
"ServiceRequest.encounter",
"Task.encounter",
"VisionPrescription.encounter"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "A date within the period the Encounter lasted"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "Identifier(s) by which this encounter is known"
},
{
"name" : "participant-type",
"definition" : "http://hl7.org/fhir/SearchParameter/Encounter-participant-type",
"type" : "token",
"documentation" : "Role of participant in encounter"
},
{
"name" : "practitioner",
"definition" : "http://hl7.org/fhir/SearchParameter/Encounter-practitioner",
"type" : "reference",
"documentation" : "Persons involved in the encounter other than the patient"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/Encounter-subject",
"type" : "reference",
"documentation" : "The patient or group present at the encounter"
},
{
"name" : "length",
"definition" : "http://hl7.org/fhir/SearchParameter/Encounter-length",
"type" : "quantity",
"documentation" : "Length of encounter in days"
},
{
"name" : "episode-of-care",
"definition" : "http://hl7.org/fhir/SearchParameter/Encounter-episode-of-care",
"type" : "reference",
"documentation" : "Episode(s) of care that this encounter should be recorded against"
},
{
"name" : "diagnosis",
"definition" : "http://hl7.org/fhir/SearchParameter/Encounter-diagnosis",
"type" : "reference",
"documentation" : "The diagnosis or procedure relevant to the encounter"
},
{
"name" : "appointment",
"definition" : "http://hl7.org/fhir/SearchParameter/Encounter-appointment",
"type" : "reference",
"documentation" : "The appointment that scheduled this encounter"
},
{
"name" : "part-of",
"definition" : "http://hl7.org/fhir/SearchParameter/Encounter-part-of",
"type" : "reference",
"documentation" : "Another Encounter this encounter is part of"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-type",
"type" : "token",
"documentation" : "Specific type of encounter"
},
{
"name" : "reason-code",
"definition" : "http://hl7.org/fhir/SearchParameter/Encounter-reason-code",
"type" : "token",
"documentation" : "Coded reason the encounter takes place"
},
{
"name" : "participant",
"definition" : "http://hl7.org/fhir/SearchParameter/Encounter-participant",
"type" : "reference",
"documentation" : "Persons involved in the encounter other than the patient"
},
{
"name" : "based-on",
"definition" : "http://hl7.org/fhir/SearchParameter/Encounter-based-on",
"type" : "reference",
"documentation" : "The ServiceRequest that initiated this encounter"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The patient or group present at the encounter"
},
{
"name" : "reason-reference",
"definition" : "http://hl7.org/fhir/SearchParameter/Encounter-reason-reference",
"type" : "reference",
"documentation" : "Reason the encounter takes place (reference)"
},
{
"name" : "location-period",
"definition" : "http://hl7.org/fhir/SearchParameter/Encounter-location-period",
"type" : "date",
"documentation" : "Time period during which the patient was present at the location"
},
{
"name" : "location",
"definition" : "http://hl7.org/fhir/SearchParameter/Encounter-location",
"type" : "reference",
"documentation" : "Location the encounter takes place"
},
{
"name" : "service-provider",
"definition" : "http://hl7.org/fhir/SearchParameter/Encounter-service-provider",
"type" : "reference",
"documentation" : "The organization (facility) responsible for this encounter"
},
{
"name" : "special-arrangement",
"definition" : "http://hl7.org/fhir/SearchParameter/Encounter-special-arrangement",
"type" : "token",
"documentation" : "Wheelchair, translator, stretcher, etc."
},
{
"name" : "class",
"definition" : "http://hl7.org/fhir/SearchParameter/Encounter-class",
"type" : "token",
"documentation" : "Classification of patient encounter"
},
{
"name" : "account",
"definition" : "http://hl7.org/fhir/SearchParameter/Encounter-account",
"type" : "reference",
"documentation" : "The set of accounts that may be used for billing for this Encounter"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Encounter-status",
"type" : "token",
"documentation" : "planned | arrived | triaged | in-progress | onleave | finished | cancelled +"
}]
},
{
"type" : "Endpoint",
"profile" : "http://hl7.org/fhir/StructureDefinition/Endpoint",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Endpoint.organization"],
"searchRevInclude" : ["HealthcareService.endpoint",
"ImagingStudy.endpoint",
"InsurancePlan.endpoint",
"Location.endpoint",
"Organization.endpoint",
"OrganizationAffiliation.endpoint",
"PractitionerRole.endpoint"],
"searchParam" : [{
"name" : "payload-type",
"definition" : "http://hl7.org/fhir/SearchParameter/Endpoint-payload-type",
"type" : "token",
"documentation" : "The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Endpoint-identifier",
"type" : "token",
"documentation" : "Identifies this endpoint across multiple systems"
},
{
"name" : "organization",
"definition" : "http://hl7.org/fhir/SearchParameter/Endpoint-organization",
"type" : "reference",
"documentation" : "The organization that is managing the endpoint"
},
{
"name" : "connection-type",
"definition" : "http://hl7.org/fhir/SearchParameter/Endpoint-connection-type",
"type" : "token",
"documentation" : "Protocol/Profile/Standard to be used with this endpoint connection"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/Endpoint-name",
"type" : "string",
"documentation" : "A name that this endpoint can be identified by"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Endpoint-status",
"type" : "token",
"documentation" : "The current status of the Endpoint (usually expected to be active)"
}]
},
{
"type" : "EnrollmentRequest",
"profile" : "http://hl7.org/fhir/StructureDefinition/EnrollmentRequest",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["EnrollmentRequest.subject",
"EnrollmentRequest.patient"],
"searchRevInclude" : ["EnrollmentResponse.request"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/EnrollmentRequest-identifier",
"type" : "token",
"documentation" : "The business identifier of the Enrollment"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/EnrollmentRequest-subject",
"type" : "reference",
"documentation" : "The party to be enrolled"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/EnrollmentRequest-patient",
"type" : "reference",
"documentation" : "The party to be enrolled"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/EnrollmentRequest-status",
"type" : "token",
"documentation" : "The status of the enrollment"
}]
},
{
"type" : "EnrollmentResponse",
"profile" : "http://hl7.org/fhir/StructureDefinition/EnrollmentResponse",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["EnrollmentResponse.request"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/EnrollmentResponse-identifier",
"type" : "token",
"documentation" : "The business identifier of the EnrollmentResponse"
},
{
"name" : "request",
"definition" : "http://hl7.org/fhir/SearchParameter/EnrollmentResponse-request",
"type" : "reference",
"documentation" : "The reference to the claim"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/EnrollmentResponse-status",
"type" : "token",
"documentation" : "The status of the enrollment response"
}]
},
{
"type" : "EpisodeOfCare",
"profile" : "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["EpisodeOfCare.condition",
"EpisodeOfCare.patient",
"EpisodeOfCare.organization",
"EpisodeOfCare.care-manager",
"EpisodeOfCare.incoming-referral"],
"searchRevInclude" : ["ChargeItem.context",
"DocumentReference.encounter",
"Encounter.episode-of-care",
"MedicationAdministration.context",
"MedicationDispense.context",
"MedicationStatement.context"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "The provided date search value falls within the episode of care's period"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "Business Identifier(s) relevant for this EpisodeOfCare"
},
{
"name" : "condition",
"definition" : "http://hl7.org/fhir/SearchParameter/EpisodeOfCare-condition",
"type" : "reference",
"documentation" : "Conditions/problems/diagnoses this episode of care is for"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The patient who is the focus of this episode of care"
},
{
"name" : "organization",
"definition" : "http://hl7.org/fhir/SearchParameter/EpisodeOfCare-organization",
"type" : "reference",
"documentation" : "The organization that has assumed the specific responsibilities of this EpisodeOfCare"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-type",
"type" : "token",
"documentation" : "Type/class - e.g. specialist referral, disease management"
},
{
"name" : "care-manager",
"definition" : "http://hl7.org/fhir/SearchParameter/EpisodeOfCare-care-manager",
"type" : "reference",
"documentation" : "Care manager/care coordinator for the patient"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/EpisodeOfCare-status",
"type" : "token",
"documentation" : "The current status of the Episode of Care as provided (does not check the status history collection)"
},
{
"name" : "incoming-referral",
"definition" : "http://hl7.org/fhir/SearchParameter/EpisodeOfCare-incoming-referral",
"type" : "reference",
"documentation" : "Incoming Referral Request"
}]
},
{
"type" : "EventDefinition",
"profile" : "http://hl7.org/fhir/StructureDefinition/EventDefinition",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["EventDefinition.successor",
"EventDefinition.derived-from",
"EventDefinition.predecessor",
"EventDefinition.composed-of",
"EventDefinition.depends-on"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/EventDefinition-date",
"type" : "date",
"documentation" : "The event definition publication date"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/EventDefinition-identifier",
"type" : "token",
"documentation" : "External identifier for the event definition"
},
{
"name" : "successor",
"definition" : "http://hl7.org/fhir/SearchParameter/EventDefinition-successor",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/EventDefinition-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the event definition"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/EventDefinition-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the event definition"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/EventDefinition-description",
"type" : "string",
"documentation" : "The description of the event definition"
},
{
"name" : "derived-from",
"definition" : "http://hl7.org/fhir/SearchParameter/EventDefinition-derived-from",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/EventDefinition-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the event definition"
},
{
"name" : "predecessor",
"definition" : "http://hl7.org/fhir/SearchParameter/EventDefinition-predecessor",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/EventDefinition-title",
"type" : "string",
"documentation" : "The human-friendly name of the event definition"
},
{
"name" : "composed-of",
"definition" : "http://hl7.org/fhir/SearchParameter/EventDefinition-composed-of",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/EventDefinition-version",
"type" : "token",
"documentation" : "The business version of the event definition"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/EventDefinition-url",
"type" : "uri",
"documentation" : "The uri that identifies the event definition"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/EventDefinition-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the event definition"
},
{
"name" : "effective",
"definition" : "http://hl7.org/fhir/SearchParameter/EventDefinition-effective",
"type" : "date",
"documentation" : "The time during which the event definition is intended to be in use"
},
{
"name" : "depends-on",
"definition" : "http://hl7.org/fhir/SearchParameter/EventDefinition-depends-on",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/EventDefinition-name",
"type" : "string",
"documentation" : "Computationally friendly name of the event definition"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/EventDefinition-context",
"type" : "token",
"documentation" : "A use context assigned to the event definition"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/EventDefinition-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the event definition"
},
{
"name" : "topic",
"definition" : "http://hl7.org/fhir/SearchParameter/EventDefinition-topic",
"type" : "token",
"documentation" : "Topics associated with the module"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/EventDefinition-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the event definition"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/EventDefinition-status",
"type" : "token",
"documentation" : "The current status of the event definition"
}]
},
{
"type" : "Evidence",
"profile" : "http://hl7.org/fhir/StructureDefinition/Evidence",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Evidence.successor",
"Evidence.derived-from",
"Evidence.predecessor",
"Evidence.composed-of",
"Evidence.depends-on"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/Evidence-date",
"type" : "date",
"documentation" : "The evidence publication date"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Evidence-identifier",
"type" : "token",
"documentation" : "External identifier for the evidence"
},
{
"name" : "successor",
"definition" : "http://hl7.org/fhir/SearchParameter/Evidence-successor",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/Evidence-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the evidence"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/Evidence-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the evidence"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/Evidence-description",
"type" : "string",
"documentation" : "The description of the evidence"
},
{
"name" : "derived-from",
"definition" : "http://hl7.org/fhir/SearchParameter/Evidence-derived-from",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/Evidence-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the evidence"
},
{
"name" : "predecessor",
"definition" : "http://hl7.org/fhir/SearchParameter/Evidence-predecessor",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/Evidence-title",
"type" : "string",
"documentation" : "The human-friendly name of the evidence"
},
{
"name" : "composed-of",
"definition" : "http://hl7.org/fhir/SearchParameter/Evidence-composed-of",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/Evidence-version",
"type" : "token",
"documentation" : "The business version of the evidence"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/Evidence-url",
"type" : "uri",
"documentation" : "The uri that identifies the evidence"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/Evidence-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the evidence"
},
{
"name" : "effective",
"definition" : "http://hl7.org/fhir/SearchParameter/Evidence-effective",
"type" : "date",
"documentation" : "The time during which the evidence is intended to be in use"
},
{
"name" : "depends-on",
"definition" : "http://hl7.org/fhir/SearchParameter/Evidence-depends-on",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/Evidence-name",
"type" : "string",
"documentation" : "Computationally friendly name of the evidence"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/Evidence-context",
"type" : "token",
"documentation" : "A use context assigned to the evidence"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/Evidence-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the evidence"
},
{
"name" : "topic",
"definition" : "http://hl7.org/fhir/SearchParameter/Evidence-topic",
"type" : "token",
"documentation" : "Topics associated with the Evidence"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/Evidence-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the evidence"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Evidence-status",
"type" : "token",
"documentation" : "The current status of the evidence"
}]
},
{
"type" : "EvidenceVariable",
"profile" : "http://hl7.org/fhir/StructureDefinition/EvidenceVariable",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["EvidenceVariable.successor",
"EvidenceVariable.derived-from",
"EvidenceVariable.predecessor",
"EvidenceVariable.composed-of",
"EvidenceVariable.depends-on"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/EvidenceVariable-date",
"type" : "date",
"documentation" : "The evidence variable publication date"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/EvidenceVariable-identifier",
"type" : "token",
"documentation" : "External identifier for the evidence variable"
},
{
"name" : "successor",
"definition" : "http://hl7.org/fhir/SearchParameter/EvidenceVariable-successor",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/EvidenceVariable-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the evidence variable"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/EvidenceVariable-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the evidence variable"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/EvidenceVariable-description",
"type" : "string",
"documentation" : "The description of the evidence variable"
},
{
"name" : "derived-from",
"definition" : "http://hl7.org/fhir/SearchParameter/EvidenceVariable-derived-from",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/EvidenceVariable-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the evidence variable"
},
{
"name" : "predecessor",
"definition" : "http://hl7.org/fhir/SearchParameter/EvidenceVariable-predecessor",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/EvidenceVariable-title",
"type" : "string",
"documentation" : "The human-friendly name of the evidence variable"
},
{
"name" : "composed-of",
"definition" : "http://hl7.org/fhir/SearchParameter/EvidenceVariable-composed-of",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/EvidenceVariable-version",
"type" : "token",
"documentation" : "The business version of the evidence variable"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/EvidenceVariable-url",
"type" : "uri",
"documentation" : "The uri that identifies the evidence variable"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/EvidenceVariable-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the evidence variable"
},
{
"name" : "effective",
"definition" : "http://hl7.org/fhir/SearchParameter/EvidenceVariable-effective",
"type" : "date",
"documentation" : "The time during which the evidence variable is intended to be in use"
},
{
"name" : "depends-on",
"definition" : "http://hl7.org/fhir/SearchParameter/EvidenceVariable-depends-on",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/EvidenceVariable-name",
"type" : "string",
"documentation" : "Computationally friendly name of the evidence variable"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/EvidenceVariable-context",
"type" : "token",
"documentation" : "A use context assigned to the evidence variable"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/EvidenceVariable-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the evidence variable"
},
{
"name" : "topic",
"definition" : "http://hl7.org/fhir/SearchParameter/EvidenceVariable-topic",
"type" : "token",
"documentation" : "Topics associated with the EvidenceVariable"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/EvidenceVariable-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the evidence variable"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/EvidenceVariable-status",
"type" : "token",
"documentation" : "The current status of the evidence variable"
}]
},
{
"type" : "ExampleScenario",
"profile" : "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/ExampleScenario-date",
"type" : "date",
"documentation" : "The example scenario publication date"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/ExampleScenario-identifier",
"type" : "token",
"documentation" : "External identifier for the example scenario"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/ExampleScenario-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the example scenario"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/ExampleScenario-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the example scenario"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/ExampleScenario-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the example scenario"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/ExampleScenario-version",
"type" : "token",
"documentation" : "The business version of the example scenario"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/ExampleScenario-url",
"type" : "uri",
"documentation" : "The uri that identifies the example scenario"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/ExampleScenario-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the example scenario"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/ExampleScenario-name",
"type" : "string",
"documentation" : "Computationally friendly name of the example scenario"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/ExampleScenario-context",
"type" : "token",
"documentation" : "A use context assigned to the example scenario"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/ExampleScenario-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the example scenario"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/ExampleScenario-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the example scenario"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/ExampleScenario-status",
"type" : "token",
"documentation" : "The current status of the example scenario"
}]
},
{
"type" : "ExplanationOfBenefit",
"profile" : "http://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["ExplanationOfBenefit.coverage",
"ExplanationOfBenefit.care-team",
"ExplanationOfBenefit.encounter",
"ExplanationOfBenefit.payee",
"ExplanationOfBenefit.provider",
"ExplanationOfBenefit.patient",
"ExplanationOfBenefit.detail-udi",
"ExplanationOfBenefit.claim",
"ExplanationOfBenefit.enterer",
"ExplanationOfBenefit.procedure-udi",
"ExplanationOfBenefit.subdetail-udi",
"ExplanationOfBenefit.facility",
"ExplanationOfBenefit.item-udi"],
"searchParam" : [{
"name" : "coverage",
"definition" : "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-coverage",
"type" : "reference",
"documentation" : "The plan under which the claim was adjudicated"
},
{
"name" : "care-team",
"definition" : "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-care-team",
"type" : "reference",
"documentation" : "Member of the CareTeam"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-identifier",
"type" : "token",
"documentation" : "The business identifier of the Explanation of Benefit"
},
{
"name" : "created",
"definition" : "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-created",
"type" : "date",
"documentation" : "The creation date for the EOB"
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-encounter",
"type" : "reference",
"documentation" : "Encounters associated with a billed line item"
},
{
"name" : "payee",
"definition" : "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-payee",
"type" : "reference",
"documentation" : "The party receiving any payment for the Claim"
},
{
"name" : "disposition",
"definition" : "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-disposition",
"type" : "string",
"documentation" : "The contents of the disposition message"
},
{
"name" : "provider",
"definition" : "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-provider",
"type" : "reference",
"documentation" : "The reference to the provider"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-patient",
"type" : "reference",
"documentation" : "The reference to the patient"
},
{
"name" : "detail-udi",
"definition" : "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-detail-udi",
"type" : "reference",
"documentation" : "UDI associated with a line item detail product or service"
},
{
"name" : "claim",
"definition" : "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-claim",
"type" : "reference",
"documentation" : "The reference to the claim"
},
{
"name" : "enterer",
"definition" : "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-enterer",
"type" : "reference",
"documentation" : "The party responsible for the entry of the Claim"
},
{
"name" : "procedure-udi",
"definition" : "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-procedure-udi",
"type" : "reference",
"documentation" : "UDI associated with a procedure"
},
{
"name" : "subdetail-udi",
"definition" : "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-subdetail-udi",
"type" : "reference",
"documentation" : "UDI associated with a line item detail subdetail product or service"
},
{
"name" : "facility",
"definition" : "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-facility",
"type" : "reference",
"documentation" : "Facility responsible for the goods and services"
},
{
"name" : "item-udi",
"definition" : "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-item-udi",
"type" : "reference",
"documentation" : "UDI associated with a line item product or service"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-status",
"type" : "token",
"documentation" : "Status of the instance"
}]
},
{
"type" : "FamilyMemberHistory",
"profile" : "http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["FamilyMemberHistory.patient",
"FamilyMemberHistory.instantiates-canonical"],
"searchRevInclude" : ["ClinicalImpression.investigation"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "When history was recorded or last updated"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "A search by a record identifier"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "A search by a condition code"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The identity of a subject to list family member history items for"
},
{
"name" : "sex",
"definition" : "http://hl7.org/fhir/SearchParameter/FamilyMemberHistory-sex",
"type" : "token",
"documentation" : "A search by a sex code of a family member"
},
{
"name" : "instantiates-canonical",
"definition" : "http://hl7.org/fhir/SearchParameter/FamilyMemberHistory-instantiates-canonical",
"type" : "reference",
"documentation" : "Instantiates FHIR protocol or definition"
},
{
"name" : "instantiates-uri",
"definition" : "http://hl7.org/fhir/SearchParameter/FamilyMemberHistory-instantiates-uri",
"type" : "uri",
"documentation" : "Instantiates external protocol or definition"
},
{
"name" : "relationship",
"definition" : "http://hl7.org/fhir/SearchParameter/FamilyMemberHistory-relationship",
"type" : "token",
"documentation" : "A search by a relationship type"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/FamilyMemberHistory-status",
"type" : "token",
"documentation" : "partial | completed | entered-in-error | health-unknown"
}]
},
{
"type" : "Flag",
"profile" : "http://hl7.org/fhir/StructureDefinition/Flag",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Flag.subject",
"Flag.patient",
"Flag.author",
"Flag.encounter"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "Time period when flag is active"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Flag-identifier",
"type" : "token",
"documentation" : "Business identifier"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/Flag-subject",
"type" : "reference",
"documentation" : "The identity of a subject to list flags for"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The identity of a subject to list flags for"
},
{
"name" : "author",
"definition" : "http://hl7.org/fhir/SearchParameter/Flag-author",
"type" : "reference",
"documentation" : "Flag creator"
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type" : "reference",
"documentation" : "Alert relevant during encounter"
}]
},
{
"type" : "Goal",
"profile" : "http://hl7.org/fhir/StructureDefinition/Goal",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Goal.patient",
"Goal.subject"],
"searchRevInclude" : ["CarePlan.goal"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "External Ids for this goal"
},
{
"name" : "lifecycle-status",
"definition" : "http://hl7.org/fhir/SearchParameter/Goal-lifecycle-status",
"type" : "token",
"documentation" : "proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected"
},
{
"name" : "achievement-status",
"definition" : "http://hl7.org/fhir/SearchParameter/Goal-achievement-status",
"type" : "token",
"documentation" : "in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Who this goal is intended for"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/Goal-subject",
"type" : "reference",
"documentation" : "Who this goal is intended for"
},
{
"name" : "start-date",
"definition" : "http://hl7.org/fhir/SearchParameter/Goal-start-date",
"type" : "date",
"documentation" : "When goal pursuit begins"
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Goal-category",
"type" : "token",
"documentation" : "E.g. Treatment, dietary, behavioral, etc."
},
{
"name" : "target-date",
"definition" : "http://hl7.org/fhir/SearchParameter/Goal-target-date",
"type" : "date",
"documentation" : "Reach goal on or before"
}]
},
{
"type" : "GraphDefinition",
"profile" : "http://hl7.org/fhir/StructureDefinition/GraphDefinition",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-date",
"type" : "date",
"documentation" : "The graph definition publication date"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the graph definition"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the graph definition"
},
{
"name" : "start",
"definition" : "http://hl7.org/fhir/SearchParameter/GraphDefinition-start",
"type" : "token",
"documentation" : "Type of resource at which the graph starts"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-description",
"type" : "string",
"documentation" : "The description of the graph definition"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the graph definition"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-version",
"type" : "token",
"documentation" : "The business version of the graph definition"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-url",
"type" : "uri",
"documentation" : "The uri that identifies the graph definition"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the graph definition"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-name",
"type" : "string",
"documentation" : "Computationally friendly name of the graph definition"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context",
"type" : "token",
"documentation" : "A use context assigned to the graph definition"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the graph definition"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the graph definition"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-status",
"type" : "token",
"documentation" : "The current status of the graph definition"
}]
},
{
"type" : "Group",
"profile" : "http://hl7.org/fhir/StructureDefinition/Group",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Group.managing-entity",
"Group.member"],
"searchRevInclude" : ["AdverseEvent.subject",
"CarePlan.subject",
"CarePlan.patient",
"CareTeam.patient",
"CareTeam.subject",
"ChargeItem.subject",
"ChargeItem.patient",
"ClinicalImpression.subject",
"ClinicalImpression.patient",
"Communication.subject",
"Communication.patient",
"Communication.recipient",
"CommunicationRequest.subject",
"CommunicationRequest.patient",
"CommunicationRequest.recipient",
"Condition.subject",
"Condition.patient",
"Consent.actor",
"DeviceRequest.subject",
"DeviceRequest.patient",
"DeviceUseStatement.subject",
"DeviceUseStatement.patient",
"DiagnosticReport.subject",
"DiagnosticReport.patient",
"DocumentManifest.subject",
"DocumentManifest.patient",
"DocumentReference.subject",
"DocumentReference.patient",
"Encounter.subject",
"Encounter.patient",
"Flag.subject",
"Flag.patient",
"Goal.patient",
"Goal.subject",
"Group.member",
"GuidanceResponse.patient",
"GuidanceResponse.subject",
"ImagingStudy.subject",
"ImagingStudy.patient",
"Invoice.subject",
"Invoice.patient",
"List.subject",
"List.patient",
"MeasureReport.patient",
"MeasureReport.subject",
"Media.subject",
"Media.patient",
"MedicationAdministration.subject",
"MedicationAdministration.patient",
"MedicationDispense.subject",
"MedicationDispense.patient",
"MedicationRequest.subject",
"MedicationRequest.patient",
"MedicationStatement.subject",
"MedicationStatement.patient",
"Observation.subject",
"Observation.patient",
"Procedure.subject",
"Procedure.patient",
"RequestGroup.subject",
"RequestGroup.patient",
"RiskAssessment.subject",
"RiskAssessment.patient",
"ServiceRequest.subject",
"ServiceRequest.patient",
"Specimen.subject",
"Specimen.patient"],
"searchParam" : [{
"name" : "actual",
"definition" : "http://hl7.org/fhir/SearchParameter/Group-actual",
"type" : "token",
"documentation" : "Descriptive or actual"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Group-identifier",
"type" : "token",
"documentation" : "Unique id"
},
{
"name" : "characteristic-value",
"definition" : "http://hl7.org/fhir/SearchParameter/Group-characteristic-value",
"type" : "composite",
"documentation" : "A composite of both characteristic and value"
},
{
"name" : "managing-entity",
"definition" : "http://hl7.org/fhir/SearchParameter/Group-managing-entity",
"type" : "reference",
"documentation" : "Entity that is the custodian of the Group's definition"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/Group-code",
"type" : "token",
"documentation" : "The kind of resources contained"
},
{
"name" : "member",
"definition" : "http://hl7.org/fhir/SearchParameter/Group-member",
"type" : "reference",
"documentation" : "Reference to the group member"
},
{
"name" : "exclude",
"definition" : "http://hl7.org/fhir/SearchParameter/Group-exclude",
"type" : "token",
"documentation" : "Group includes or excludes"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/Group-type",
"type" : "token",
"documentation" : "The type of resources the group contains"
},
{
"name" : "value",
"definition" : "http://hl7.org/fhir/SearchParameter/Group-value",
"type" : "token",
"documentation" : "Value held by characteristic"
},
{
"name" : "characteristic",
"definition" : "http://hl7.org/fhir/SearchParameter/Group-characteristic",
"type" : "token",
"documentation" : "Kind of characteristic"
}]
},
{
"type" : "GuidanceResponse",
"profile" : "http://hl7.org/fhir/StructureDefinition/GuidanceResponse",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["GuidanceResponse.patient",
"GuidanceResponse.subject"],
"searchParam" : [{
"name" : "request",
"definition" : "http://hl7.org/fhir/SearchParameter/GuidanceResponse-request",
"type" : "token",
"documentation" : "The identifier of the request associated with the response"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/GuidanceResponse-identifier",
"type" : "token",
"documentation" : "The identifier of the guidance response"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/GuidanceResponse-patient",
"type" : "reference",
"documentation" : "The identity of a patient to search for guidance response results"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/GuidanceResponse-subject",
"type" : "reference",
"documentation" : "The subject that the guidance response is about"
}]
},
{
"type" : "HealthcareService",
"profile" : "http://hl7.org/fhir/StructureDefinition/HealthcareService",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["HealthcareService.endpoint",
"HealthcareService.coverage-area",
"HealthcareService.organization",
"HealthcareService.location"],
"searchRevInclude" : ["Account.subject",
"Account.patient",
"Appointment.practitioner",
"Appointment.actor",
"Appointment.patient",
"Appointment.location",
"AppointmentResponse.actor",
"AppointmentResponse.practitioner",
"AppointmentResponse.patient",
"AppointmentResponse.location",
"CarePlan.performer",
"Communication.sender",
"Communication.recipient",
"CommunicationRequest.sender",
"CommunicationRequest.recipient",
"DeviceRequest.performer",
"OrganizationAffiliation.service",
"PractitionerRole.service",
"Schedule.actor",
"ServiceRequest.performer",
"SupplyRequest.supplier",
"Task.owner"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/HealthcareService-identifier",
"type" : "token",
"documentation" : "External identifiers for this item"
},
{
"name" : "specialty",
"definition" : "http://hl7.org/fhir/SearchParameter/HealthcareService-specialty",
"type" : "token",
"documentation" : "The specialty of the service provided by this healthcare service"
},
{
"name" : "endpoint",
"definition" : "http://hl7.org/fhir/SearchParameter/HealthcareService-endpoint",
"type" : "reference",
"documentation" : "Technical endpoints providing access to electronic services operated for the healthcare service"
},
{
"name" : "service-category",
"definition" : "http://hl7.org/fhir/SearchParameter/HealthcareService-service-category",
"type" : "token",
"documentation" : "Service Category of the Healthcare Service"
},
{
"name" : "coverage-area",
"definition" : "http://hl7.org/fhir/SearchParameter/HealthcareService-coverage-area",
"type" : "reference",
"documentation" : "Location(s) service is intended for/available to"
},
{
"name" : "service-type",
"definition" : "http://hl7.org/fhir/SearchParameter/HealthcareService-service-type",
"type" : "token",
"documentation" : "The type of service provided by this healthcare service"
},
{
"name" : "organization",
"definition" : "http://hl7.org/fhir/SearchParameter/HealthcareService-organization",
"type" : "reference",
"documentation" : "The organization that provides this Healthcare Service"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/HealthcareService-name",
"type" : "string",
"documentation" : "A portion of the Healthcare service name"
},
{
"name" : "active",
"definition" : "http://hl7.org/fhir/SearchParameter/HealthcareService-active",
"type" : "token",
"documentation" : "The Healthcare Service is currently marked as active"
},
{
"name" : "location",
"definition" : "http://hl7.org/fhir/SearchParameter/HealthcareService-location",
"type" : "reference",
"documentation" : "The location of the Healthcare Service"
},
{
"name" : "program",
"definition" : "http://hl7.org/fhir/SearchParameter/HealthcareService-program",
"type" : "token",
"documentation" : "One of the Programs supported by this HealthcareService"
},
{
"name" : "characteristic",
"definition" : "http://hl7.org/fhir/SearchParameter/HealthcareService-characteristic",
"type" : "token",
"documentation" : "One of the HealthcareService's characteristics"
}]
},
{
"type" : "ImagingStudy",
"profile" : "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["ImagingStudy.performer",
"ImagingStudy.subject",
"ImagingStudy.interpreter",
"ImagingStudy.encounter",
"ImagingStudy.referrer",
"ImagingStudy.endpoint",
"ImagingStudy.patient",
"ImagingStudy.basedon"],
"searchRevInclude" : ["ChargeItem.service",
"ClinicalImpression.investigation",
"Observation.derived-from",
"Observation.part-of"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "Identifiers for the Study, such as DICOM Study Instance UID and Accession number"
},
{
"name" : "reason",
"definition" : "http://hl7.org/fhir/SearchParameter/ImagingStudy-reason",
"type" : "token",
"documentation" : "The reason for the study"
},
{
"name" : "dicom-class",
"definition" : "http://hl7.org/fhir/SearchParameter/ImagingStudy-dicom-class",
"type" : "token",
"documentation" : "The type of the instance"
},
{
"name" : "modality",
"definition" : "http://hl7.org/fhir/SearchParameter/ImagingStudy-modality",
"type" : "token",
"documentation" : "The modality of the series"
},
{
"name" : "bodysite",
"definition" : "http://hl7.org/fhir/SearchParameter/ImagingStudy-bodysite",
"type" : "token",
"documentation" : "The body site studied"
},
{
"name" : "instance",
"definition" : "http://hl7.org/fhir/SearchParameter/ImagingStudy-instance",
"type" : "token",
"documentation" : "SOP Instance UID for an instance"
},
{
"name" : "performer",
"definition" : "http://hl7.org/fhir/SearchParameter/ImagingStudy-performer",
"type" : "reference",
"documentation" : "The person who performed the study"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/ImagingStudy-subject",
"type" : "reference",
"documentation" : "Who the study is about"
},
{
"name" : "started",
"definition" : "http://hl7.org/fhir/SearchParameter/ImagingStudy-started",
"type" : "date",
"documentation" : "When the study was started"
},
{
"name" : "interpreter",
"definition" : "http://hl7.org/fhir/SearchParameter/ImagingStudy-interpreter",
"type" : "reference",
"documentation" : "Who interpreted the images"
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/ImagingStudy-encounter",
"type" : "reference",
"documentation" : "The context of the study"
},
{
"name" : "referrer",
"definition" : "http://hl7.org/fhir/SearchParameter/ImagingStudy-referrer",
"type" : "reference",
"documentation" : "The referring physician"
},
{
"name" : "endpoint",
"definition" : "http://hl7.org/fhir/SearchParameter/ImagingStudy-endpoint",
"type" : "reference",
"documentation" : "The endpoint for the study or series"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Who the study is about"
},
{
"name" : "series",
"definition" : "http://hl7.org/fhir/SearchParameter/ImagingStudy-series",
"type" : "token",
"documentation" : "DICOM Series Instance UID for a series"
},
{
"name" : "basedon",
"definition" : "http://hl7.org/fhir/SearchParameter/ImagingStudy-basedon",
"type" : "reference",
"documentation" : "The order for the image"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/ImagingStudy-status",
"type" : "token",
"documentation" : "The status of the study"
}]
},
{
"type" : "Immunization",
"profile" : "http://hl7.org/fhir/StructureDefinition/Immunization",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Immunization.performer",
"Immunization.reaction",
"Immunization.manufacturer",
"Immunization.patient",
"Immunization.reason-reference",
"Immunization.location"],
"searchRevInclude" : ["AdverseEvent.substance",
"ChargeItem.service",
"ImmunizationEvaluation.immunization-event",
"ImmunizationRecommendation.support",
"Observation.part-of"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "Vaccination (non)-Administration Date"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "Business identifier"
},
{
"name" : "performer",
"definition" : "http://hl7.org/fhir/SearchParameter/Immunization-performer",
"type" : "reference",
"documentation" : "The practitioner or organization who played a role in the vaccination"
},
{
"name" : "reaction",
"definition" : "http://hl7.org/fhir/SearchParameter/Immunization-reaction",
"type" : "reference",
"documentation" : "Additional information on reaction"
},
{
"name" : "lot-number",
"definition" : "http://hl7.org/fhir/SearchParameter/Immunization-lot-number",
"type" : "string",
"documentation" : "Vaccine Lot Number"
},
{
"name" : "status-reason",
"definition" : "http://hl7.org/fhir/SearchParameter/Immunization-status-reason",
"type" : "token",
"documentation" : "Reason why the vaccine was not administered"
},
{
"name" : "reason-code",
"definition" : "http://hl7.org/fhir/SearchParameter/Immunization-reason-code",
"type" : "token",
"documentation" : "Reason why the vaccine was administered"
},
{
"name" : "manufacturer",
"definition" : "http://hl7.org/fhir/SearchParameter/Immunization-manufacturer",
"type" : "reference",
"documentation" : "Vaccine Manufacturer"
},
{
"name" : "target-disease",
"definition" : "http://hl7.org/fhir/SearchParameter/Immunization-target-disease",
"type" : "token",
"documentation" : "The target disease the dose is being administered against"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The patient for the vaccination record"
},
{
"name" : "series",
"definition" : "http://hl7.org/fhir/SearchParameter/Immunization-series",
"type" : "string",
"documentation" : "The series being followed by the provider"
},
{
"name" : "vaccine-code",
"definition" : "http://hl7.org/fhir/SearchParameter/Immunization-vaccine-code",
"type" : "token",
"documentation" : "Vaccine Product Administered"
},
{
"name" : "reason-reference",
"definition" : "http://hl7.org/fhir/SearchParameter/Immunization-reason-reference",
"type" : "reference",
"documentation" : "Why immunization occurred"
},
{
"name" : "location",
"definition" : "http://hl7.org/fhir/SearchParameter/Immunization-location",
"type" : "reference",
"documentation" : "The service delivery location or facility in which the vaccine was / was to be administered"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Immunization-status",
"type" : "token",
"documentation" : "Immunization event status"
},
{
"name" : "reaction-date",
"definition" : "http://hl7.org/fhir/SearchParameter/Immunization-reaction-date",
"type" : "date",
"documentation" : "When reaction started"
}]
},
{
"type" : "ImmunizationEvaluation",
"profile" : "http://hl7.org/fhir/StructureDefinition/ImmunizationEvaluation",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["ImmunizationEvaluation.patient",
"ImmunizationEvaluation.immunization-event"],
"searchRevInclude" : ["ImmunizationRecommendation.support"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/ImmunizationEvaluation-date",
"type" : "date",
"documentation" : "Date the evaluation was generated"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/ImmunizationEvaluation-identifier",
"type" : "token",
"documentation" : "ID of the evaluation"
},
{
"name" : "target-disease",
"definition" : "http://hl7.org/fhir/SearchParameter/ImmunizationEvaluation-target-disease",
"type" : "token",
"documentation" : "The vaccine preventable disease being evaluated against"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/ImmunizationEvaluation-patient",
"type" : "reference",
"documentation" : "The patient being evaluated"
},
{
"name" : "dose-status",
"definition" : "http://hl7.org/fhir/SearchParameter/ImmunizationEvaluation-dose-status",
"type" : "token",
"documentation" : "The status of the dose relative to published recommendations"
},
{
"name" : "immunization-event",
"definition" : "http://hl7.org/fhir/SearchParameter/ImmunizationEvaluation-immunization-event",
"type" : "reference",
"documentation" : "The vaccine administration event being evaluated"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/ImmunizationEvaluation-status",
"type" : "token",
"documentation" : "Immunization evaluation status"
}]
},
{
"type" : "ImmunizationRecommendation",
"profile" : "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["ImmunizationRecommendation.patient",
"ImmunizationRecommendation.information",
"ImmunizationRecommendation.support"],
"searchRevInclude" : ["Appointment.reason-reference",
"DiagnosticReport.based-on",
"Encounter.reason-reference",
"Observation.based-on"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-date",
"type" : "date",
"documentation" : "Date recommendation(s) created"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-identifier",
"type" : "token",
"documentation" : "Business identifier"
},
{
"name" : "target-disease",
"definition" : "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-target-disease",
"type" : "token",
"documentation" : "Disease to be immunized against"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-patient",
"type" : "reference",
"documentation" : "Who this profile is for"
},
{
"name" : "vaccine-type",
"definition" : "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-vaccine-type",
"type" : "token",
"documentation" : "Vaccine or vaccine group recommendation applies to"
},
{
"name" : "information",
"definition" : "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-information",
"type" : "reference",
"documentation" : "Patient observations supporting recommendation"
},
{
"name" : "support",
"definition" : "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-support",
"type" : "reference",
"documentation" : "Past immunizations supporting recommendation"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-status",
"type" : "token",
"documentation" : "Vaccine recommendation status"
}]
},
{
"type" : "ImplementationGuide",
"profile" : "http://hl7.org/fhir/StructureDefinition/ImplementationGuide",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["ImplementationGuide.resource",
"ImplementationGuide.global",
"ImplementationGuide.depends-on"],
"searchRevInclude" : ["CapabilityStatement.guide",
"ImplementationGuide.depends-on"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-date",
"type" : "date",
"documentation" : "The implementation guide publication date"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the implementation guide"
},
{
"name" : "resource",
"definition" : "http://hl7.org/fhir/SearchParameter/ImplementationGuide-resource",
"type" : "reference",
"documentation" : "Location of the resource"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the implementation guide"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-description",
"type" : "string",
"documentation" : "The description of the implementation guide"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the implementation guide"
},
{
"name" : "experimental",
"definition" : "http://hl7.org/fhir/SearchParameter/ImplementationGuide-experimental",
"type" : "token",
"documentation" : "For testing purposes, not real usage"
},
{
"name" : "global",
"definition" : "http://hl7.org/fhir/SearchParameter/ImplementationGuide-global",
"type" : "reference",
"documentation" : "Profile that all resources must conform to"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-title",
"type" : "string",
"documentation" : "The human-friendly name of the implementation guide"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-version",
"type" : "token",
"documentation" : "The business version of the implementation guide"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-url",
"type" : "uri",
"documentation" : "The uri that identifies the implementation guide"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the implementation guide"
},
{
"name" : "depends-on",
"definition" : "http://hl7.org/fhir/SearchParameter/ImplementationGuide-depends-on",
"type" : "reference",
"documentation" : "Identity of the IG that this depends on"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-name",
"type" : "string",
"documentation" : "Computationally friendly name of the implementation guide"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context",
"type" : "token",
"documentation" : "A use context assigned to the implementation guide"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the implementation guide"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the implementation guide"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-status",
"type" : "token",
"documentation" : "The current status of the implementation guide"
}]
},
{
"type" : "InsurancePlan",
"profile" : "http://hl7.org/fhir/StructureDefinition/InsurancePlan",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["InsurancePlan.owned-by",
"InsurancePlan.administered-by",
"InsurancePlan.endpoint"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/InsurancePlan-identifier",
"type" : "token",
"documentation" : "Any identifier for the organization (not the accreditation issuer's identifier)"
},
{
"name" : "address",
"definition" : "http://hl7.org/fhir/SearchParameter/InsurancePlan-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",
"definition" : "http://hl7.org/fhir/SearchParameter/InsurancePlan-address-state",
"type" : "string",
"documentation" : "A state specified in an address"
},
{
"name" : "owned-by",
"definition" : "http://hl7.org/fhir/SearchParameter/InsurancePlan-owned-by",
"type" : "reference",
"documentation" : "An organization of which this organization forms a part"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/InsurancePlan-type",
"type" : "token",
"documentation" : "A code for the type of organization"
},
{
"name" : "address-postalcode",
"definition" : "http://hl7.org/fhir/SearchParameter/InsurancePlan-address-postalcode",
"type" : "string",
"documentation" : "A postal code specified in an address"
},
{
"name" : "administered-by",
"definition" : "http://hl7.org/fhir/SearchParameter/InsurancePlan-administered-by",
"type" : "reference",
"documentation" : "Product administrator"
},
{
"name" : "address-country",
"definition" : "http://hl7.org/fhir/SearchParameter/InsurancePlan-address-country",
"type" : "string",
"documentation" : "A country specified in an address"
},
{
"name" : "endpoint",
"definition" : "http://hl7.org/fhir/SearchParameter/InsurancePlan-endpoint",
"type" : "reference",
"documentation" : "Technical endpoint"
},
{
"name" : "phonetic",
"definition" : "http://hl7.org/fhir/SearchParameter/InsurancePlan-phonetic",
"type" : "string",
"documentation" : "A portion of the organization's name using some kind of phonetic matching algorithm"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/InsurancePlan-name",
"type" : "string",
"documentation" : "A portion of the organization's name or alias"
},
{
"name" : "address-use",
"definition" : "http://hl7.org/fhir/SearchParameter/InsurancePlan-address-use",
"type" : "token",
"documentation" : "A use code specified in an address"
},
{
"name" : "address-city",
"definition" : "http://hl7.org/fhir/SearchParameter/InsurancePlan-address-city",
"type" : "string",
"documentation" : "A city specified in an address"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/InsurancePlan-status",
"type" : "token",
"documentation" : "Is the Organization record active"
}]
},
{
"type" : "Invoice",
"profile" : "http://hl7.org/fhir/StructureDefinition/Invoice",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Invoice.subject",
"Invoice.issuer",
"Invoice.participant",
"Invoice.patient",
"Invoice.recipient",
"Invoice.account"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/Invoice-date",
"type" : "date",
"documentation" : "Invoice date / posting date"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Invoice-identifier",
"type" : "token",
"documentation" : "Business Identifier for item"
},
{
"name" : "totalgross",
"definition" : "http://hl7.org/fhir/SearchParameter/Invoice-totalgross",
"type" : "quantity",
"documentation" : "Gross total of this Invoice"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/Invoice-subject",
"type" : "reference",
"documentation" : "Recipient(s) of goods and services"
},
{
"name" : "participant-role",
"definition" : "http://hl7.org/fhir/SearchParameter/Invoice-participant-role",
"type" : "token",
"documentation" : "Type of involvement in creation of this Invoice"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/Invoice-type",
"type" : "token",
"documentation" : "Type of Invoice"
},
{
"name" : "issuer",
"definition" : "http://hl7.org/fhir/SearchParameter/Invoice-issuer",
"type" : "reference",
"documentation" : "Issuing Organization of Invoice"
},
{
"name" : "participant",
"definition" : "http://hl7.org/fhir/SearchParameter/Invoice-participant",
"type" : "reference",
"documentation" : "Individual who was involved"
},
{
"name" : "totalnet",
"definition" : "http://hl7.org/fhir/SearchParameter/Invoice-totalnet",
"type" : "quantity",
"documentation" : "Net total of this Invoice"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/Invoice-patient",
"type" : "reference",
"documentation" : "Recipient(s) of goods and services"
},
{
"name" : "recipient",
"definition" : "http://hl7.org/fhir/SearchParameter/Invoice-recipient",
"type" : "reference",
"documentation" : "Recipient of this invoice"
},
{
"name" : "account",
"definition" : "http://hl7.org/fhir/SearchParameter/Invoice-account",
"type" : "reference",
"documentation" : "Account that is being balanced"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Invoice-status",
"type" : "token",
"documentation" : "draft | issued | balanced | cancelled | entered-in-error"
}]
},
{
"type" : "Library",
"profile" : "http://hl7.org/fhir/StructureDefinition/Library",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Library.successor",
"Library.derived-from",
"Library.predecessor",
"Library.composed-of",
"Library.depends-on"],
"searchRevInclude" : ["ActivityDefinition.depends-on",
"Measure.depends-on",
"PlanDefinition.depends-on",
"ResearchDefinition.depends-on",
"ResearchElementDefinition.depends-on"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-date",
"type" : "date",
"documentation" : "The library publication date"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-identifier",
"type" : "token",
"documentation" : "External identifier for the library"
},
{
"name" : "successor",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-successor",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the library"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the library"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-description",
"type" : "string",
"documentation" : "The description of the library"
},
{
"name" : "derived-from",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-derived-from",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the library"
},
{
"name" : "predecessor",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-predecessor",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-title",
"type" : "string",
"documentation" : "The human-friendly name of the library"
},
{
"name" : "composed-of",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-composed-of",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-type",
"type" : "token",
"documentation" : "The type of the library (e.g. logic-library, model-definition, asset-collection, module-definition)"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-version",
"type" : "token",
"documentation" : "The business version of the library"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-url",
"type" : "uri",
"documentation" : "The uri that identifies the library"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the library"
},
{
"name" : "effective",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-effective",
"type" : "date",
"documentation" : "The time during which the library is intended to be in use"
},
{
"name" : "depends-on",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-depends-on",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-name",
"type" : "string",
"documentation" : "Computationally friendly name of the library"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-context",
"type" : "token",
"documentation" : "A use context assigned to the library"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the library"
},
{
"name" : "topic",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-topic",
"type" : "token",
"documentation" : "Topics associated with the module"
},
{
"name" : "content-type",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-content-type",
"type" : "token",
"documentation" : "The type of content in the library (e.g. text/cql)"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the library"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-status",
"type" : "token",
"documentation" : "The current status of the library"
}]
},
{
"type" : "Linkage",
"profile" : "http://hl7.org/fhir/StructureDefinition/Linkage",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Linkage.item",
"Linkage.author",
"Linkage.source"],
"searchParam" : [{
"name" : "item",
"definition" : "http://hl7.org/fhir/SearchParameter/Linkage-item",
"type" : "reference",
"documentation" : "Matches on any item in the Linkage"
},
{
"name" : "author",
"definition" : "http://hl7.org/fhir/SearchParameter/Linkage-author",
"type" : "reference",
"documentation" : "Author of the Linkage"
},
{
"name" : "source",
"definition" : "http://hl7.org/fhir/SearchParameter/Linkage-source",
"type" : "reference",
"documentation" : "Matches on any item in the Linkage with a type of 'source'"
}]
},
{
"type" : "List",
"profile" : "http://hl7.org/fhir/StructureDefinition/List",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["List.item",
"List.subject",
"List.patient",
"List.source",
"List.encounter"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "When the list was prepared"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "Business identifier"
},
{
"name" : "item",
"definition" : "http://hl7.org/fhir/SearchParameter/List-item",
"type" : "reference",
"documentation" : "Actual entry"
},
{
"name" : "empty-reason",
"definition" : "http://hl7.org/fhir/SearchParameter/List-empty-reason",
"type" : "token",
"documentation" : "Why list is empty"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "What the purpose of this list is"
},
{
"name" : "notes",
"definition" : "http://hl7.org/fhir/SearchParameter/List-notes",
"type" : "string",
"documentation" : "The annotation - text content (as markdown)"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/List-subject",
"type" : "reference",
"documentation" : "If all resources have the same subject"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "If all resources have the same subject"
},
{
"name" : "source",
"definition" : "http://hl7.org/fhir/SearchParameter/List-source",
"type" : "reference",
"documentation" : "Who and/or what defined the list contents (aka Author)"
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type" : "reference",
"documentation" : "Context in which list created"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/List-title",
"type" : "string",
"documentation" : "Descriptive name for the list"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/List-status",
"type" : "token",
"documentation" : "current | retired | entered-in-error"
}]
},
{
"type" : "Location",
"profile" : "http://hl7.org/fhir/StructureDefinition/Location",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Location.partof",
"Location.endpoint",
"Location.organization"],
"searchRevInclude" : ["Account.subject",
"Account.patient",
"AdverseEvent.location",
"Appointment.practitioner",
"Appointment.actor",
"Appointment.patient",
"Appointment.location",
"AppointmentResponse.actor",
"AppointmentResponse.practitioner",
"AppointmentResponse.patient",
"AppointmentResponse.location",
"Claim.facility",
"Contract.domain",
"CoverageEligibilityRequest.facility",
"Device.location",
"DeviceRequest.subject",
"DeviceRequest.patient",
"DiagnosticReport.subject",
"DiagnosticReport.patient",
"Encounter.location",
"ExplanationOfBenefit.facility",
"Flag.subject",
"Flag.patient",
"HealthcareService.coverage-area",
"HealthcareService.location",
"Immunization.location",
"List.subject",
"List.patient",
"Location.partof",
"MeasureReport.patient",
"MeasureReport.subject",
"MeasureReport.reporter",
"Media.subject",
"Media.patient",
"MedicationDispense.destination",
"Observation.subject",
"Observation.patient",
"OrganizationAffiliation.location",
"PractitionerRole.location",
"Procedure.location",
"Provenance.location",
"ResearchStudy.site",
"Schedule.actor",
"ServiceRequest.subject",
"ServiceRequest.patient",
"Specimen.subject",
"Specimen.patient",
"SupplyRequest.subject"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Location-identifier",
"type" : "token",
"documentation" : "An identifier for the location"
},
{
"name" : "partof",
"definition" : "http://hl7.org/fhir/SearchParameter/Location-partof",
"type" : "reference",
"documentation" : "A location of which this location is a part"
},
{
"name" : "address",
"definition" : "http://hl7.org/fhir/SearchParameter/Location-address",
"type" : "string",
"documentation" : "A (part of the) address of the location"
},
{
"name" : "address-state",
"definition" : "http://hl7.org/fhir/SearchParameter/Location-address-state",
"type" : "string",
"documentation" : "A state specified in an address"
},
{
"name" : "operational-status",
"definition" : "http://hl7.org/fhir/SearchParameter/Location-operational-status",
"type" : "token",
"documentation" : "Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping)"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/Location-type",
"type" : "token",
"documentation" : "A code for the type of location"
},
{
"name" : "address-postalcode",
"definition" : "http://hl7.org/fhir/SearchParameter/Location-address-postalcode",
"type" : "string",
"documentation" : "A postal code specified in an address"
},
{
"name" : "address-country",
"definition" : "http://hl7.org/fhir/SearchParameter/Location-address-country",
"type" : "string",
"documentation" : "A country specified in an address"
},
{
"name" : "endpoint",
"definition" : "http://hl7.org/fhir/SearchParameter/Location-endpoint",
"type" : "reference",
"documentation" : "Technical endpoints providing access to services operated for the location"
},
{
"name" : "organization",
"definition" : "http://hl7.org/fhir/SearchParameter/Location-organization",
"type" : "reference",
"documentation" : "Searches for locations that are managed by the provided organization"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/Location-name",
"type" : "string",
"documentation" : "A portion of the location's name or alias"
},
{
"name" : "address-use",
"definition" : "http://hl7.org/fhir/SearchParameter/Location-address-use",
"type" : "token",
"documentation" : "A use code specified in an address"
},
{
"name" : "near",
"definition" : "http://hl7.org/fhir/SearchParameter/Location-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",
"definition" : "http://hl7.org/fhir/SearchParameter/Location-address-city",
"type" : "string",
"documentation" : "A city specified in an address"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Location-status",
"type" : "token",
"documentation" : "Searches for locations with a specific kind of status"
}]
},
{
"type" : "Measure",
"profile" : "http://hl7.org/fhir/StructureDefinition/Measure",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Measure.successor",
"Measure.derived-from",
"Measure.predecessor",
"Measure.composed-of",
"Measure.depends-on"],
"searchRevInclude" : ["CarePlan.instantiates-canonical",
"Communication.instantiates-canonical",
"FamilyMemberHistory.instantiates-canonical",
"MeasureReport.measure",
"Procedure.instantiates-canonical"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-date",
"type" : "date",
"documentation" : "The measure publication date"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-identifier",
"type" : "token",
"documentation" : "External identifier for the measure"
},
{
"name" : "successor",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-successor",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the measure"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the measure"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-description",
"type" : "string",
"documentation" : "The description of the measure"
},
{
"name" : "derived-from",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-derived-from",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the measure"
},
{
"name" : "predecessor",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-predecessor",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-title",
"type" : "string",
"documentation" : "The human-friendly name of the measure"
},
{
"name" : "composed-of",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-composed-of",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-version",
"type" : "token",
"documentation" : "The business version of the measure"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-url",
"type" : "uri",
"documentation" : "The uri that identifies the measure"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the measure"
},
{
"name" : "effective",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-effective",
"type" : "date",
"documentation" : "The time during which the measure is intended to be in use"
},
{
"name" : "depends-on",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-depends-on",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-name",
"type" : "string",
"documentation" : "Computationally friendly name of the measure"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-context",
"type" : "token",
"documentation" : "A use context assigned to the measure"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the measure"
},
{
"name" : "topic",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-topic",
"type" : "token",
"documentation" : "Topics associated with the measure"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the measure"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-status",
"type" : "token",
"documentation" : "The current status of the measure"
}]
},
{
"type" : "MeasureReport",
"profile" : "http://hl7.org/fhir/StructureDefinition/MeasureReport",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["MeasureReport.measure",
"MeasureReport.patient",
"MeasureReport.subject",
"MeasureReport.reporter",
"MeasureReport.evaluated-resource"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-date",
"type" : "date",
"documentation" : "The date of the measure report"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-identifier",
"type" : "token",
"documentation" : "External identifier of the measure report to be returned"
},
{
"name" : "period",
"definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-period",
"type" : "date",
"documentation" : "The period of the measure report"
},
{
"name" : "measure",
"definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-measure",
"type" : "reference",
"documentation" : "The measure to return measure report results for"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-patient",
"type" : "reference",
"documentation" : "The identity of a patient to search for individual measure report results for"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-subject",
"type" : "reference",
"documentation" : "The identity of a subject to search for individual measure report results for"
},
{
"name" : "reporter",
"definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-reporter",
"type" : "reference",
"documentation" : "The reporter to return measure report results for"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-status",
"type" : "token",
"documentation" : "The status of the measure report"
},
{
"name" : "evaluated-resource",
"definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-evaluated-resource",
"type" : "reference",
"documentation" : "An evaluated resource referenced by the measure report"
}]
},
{
"type" : "Media",
"profile" : "http://hl7.org/fhir/StructureDefinition/Media",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Media.subject",
"Media.encounter",
"Media.operator",
"Media.based-on",
"Media.patient",
"Media.device"],
"searchRevInclude" : ["ClinicalImpression.finding-ref",
"ClinicalImpression.investigation",
"DiagnosticReport.media",
"MedicationKnowledge.monograph",
"Observation.derived-from"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Media-identifier",
"type" : "token",
"documentation" : "Identifier(s) for the image"
},
{
"name" : "modality",
"definition" : "http://hl7.org/fhir/SearchParameter/Media-modality",
"type" : "token",
"documentation" : "The type of acquisition equipment/process"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/Media-subject",
"type" : "reference",
"documentation" : "Who/What this Media is a record of"
},
{
"name" : "created",
"definition" : "http://hl7.org/fhir/SearchParameter/Media-created",
"type" : "date",
"documentation" : "When Media was collected"
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/Media-encounter",
"type" : "reference",
"documentation" : "Encounter associated with media"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/Media-type",
"type" : "token",
"documentation" : "Classification of media as image, video, or audio"
},
{
"name" : "operator",
"definition" : "http://hl7.org/fhir/SearchParameter/Media-operator",
"type" : "reference",
"documentation" : "The person who generated the image"
},
{
"name" : "view",
"definition" : "http://hl7.org/fhir/SearchParameter/Media-view",
"type" : "token",
"documentation" : "Imaging view, e.g. Lateral or Antero-posterior"
},
{
"name" : "site",
"definition" : "http://hl7.org/fhir/SearchParameter/Media-site",
"type" : "token",
"documentation" : "Observed body part"
},
{
"name" : "based-on",
"definition" : "http://hl7.org/fhir/SearchParameter/Media-based-on",
"type" : "reference",
"documentation" : "Procedure that caused this media to be created"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/Media-patient",
"type" : "reference",
"documentation" : "Who/What this Media is a record of"
},
{
"name" : "device",
"definition" : "http://hl7.org/fhir/SearchParameter/Media-device",
"type" : "reference",
"documentation" : "Observing Device"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Media-status",
"type" : "token",
"documentation" : "preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error | unknown"
}]
},
{
"type" : "Medication",
"profile" : "http://hl7.org/fhir/StructureDefinition/Medication",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Medication.ingredient",
"Medication.manufacturer"],
"searchRevInclude" : ["AdverseEvent.substance",
"Flag.subject",
"Flag.patient",
"Group.member",
"Medication.ingredient",
"MedicationAdministration.medication",
"MedicationDispense.medication",
"MedicationRequest.medication",
"MedicationStatement.medication",
"MedicinalProductContraindication.subject",
"MedicinalProductIndication.subject",
"MedicinalProductInteraction.subject",
"MedicinalProductUndesirableEffect.subject"],
"searchParam" : [{
"name" : "ingredient-code",
"definition" : "http://hl7.org/fhir/SearchParameter/Medication-ingredient-code",
"type" : "token",
"documentation" : "Returns medications for this ingredient code"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Medication-identifier",
"type" : "token",
"documentation" : "Returns medications with this external identifier"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "Returns medications for a specific code"
},
{
"name" : "ingredient",
"definition" : "http://hl7.org/fhir/SearchParameter/Medication-ingredient",
"type" : "reference",
"documentation" : "Returns medications for this ingredient reference"
},
{
"name" : "form",
"definition" : "http://hl7.org/fhir/SearchParameter/Medication-form",
"type" : "token",
"documentation" : "Returns medications for a specific dose form"
},
{
"name" : "lot-number",
"definition" : "http://hl7.org/fhir/SearchParameter/Medication-lot-number",
"type" : "token",
"documentation" : "Returns medications in a batch with this lot number"
},
{
"name" : "expiration-date",
"definition" : "http://hl7.org/fhir/SearchParameter/Medication-expiration-date",
"type" : "date",
"documentation" : "Returns medications in a batch with this expiration date"
},
{
"name" : "manufacturer",
"definition" : "http://hl7.org/fhir/SearchParameter/Medication-manufacturer",
"type" : "reference",
"documentation" : "Returns medications made or sold for this manufacturer"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Medication-status",
"type" : "token",
"documentation" : "Returns medications for this status"
}]
},
{
"type" : "MedicationAdministration",
"profile" : "http://hl7.org/fhir/StructureDefinition/MedicationAdministration",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["MedicationAdministration.request",
"MedicationAdministration.performer",
"MedicationAdministration.subject",
"MedicationAdministration.medication",
"MedicationAdministration.patient",
"MedicationAdministration.context",
"MedicationAdministration.device"],
"searchRevInclude" : ["AdverseEvent.substance",
"ChargeItem.service",
"MedicationStatement.part-of",
"Observation.part-of",
"Procedure.part-of"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "Return administrations with this external identifier"
},
{
"name" : "request",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationAdministration-request",
"type" : "reference",
"documentation" : "The identity of a request to list administrations from"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "Return administrations of this medication code"
},
{
"name" : "performer",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationAdministration-performer",
"type" : "reference",
"documentation" : "The identity of the individual who administered the medication"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationAdministration-subject",
"type" : "reference",
"documentation" : "The identity of the individual or group to list administrations for"
},
{
"name" : "medication",
"definition" : "http://hl7.org/fhir/SearchParameter/medications-medication",
"type" : "reference",
"documentation" : "Return administrations of this medication resource"
},
{
"name" : "reason-given",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationAdministration-reason-given",
"type" : "token",
"documentation" : "Reasons for administering the medication"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The identity of a patient to list administrations for"
},
{
"name" : "effective-time",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationAdministration-effective-time",
"type" : "date",
"documentation" : "Date administration happened (or did not happen)"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationAdministration-context",
"type" : "reference",
"documentation" : "Return administrations that share this encounter or episode of care"
},
{
"name" : "reason-not-given",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationAdministration-reason-not-given",
"type" : "token",
"documentation" : "Reasons for not administering the medication"
},
{
"name" : "device",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationAdministration-device",
"type" : "reference",
"documentation" : "Return administrations with this administration device identity"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/medications-status",
"type" : "token",
"documentation" : "MedicationAdministration event status (for example one of active/paused/completed/nullified)"
}]
},
{
"type" : "MedicationDispense",
"profile" : "http://hl7.org/fhir/StructureDefinition/MedicationDispense",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["MedicationDispense.performer",
"MedicationDispense.receiver",
"MedicationDispense.subject",
"MedicationDispense.destination",
"MedicationDispense.medication",
"MedicationDispense.responsibleparty",
"MedicationDispense.prescription",
"MedicationDispense.patient",
"MedicationDispense.context"],
"searchRevInclude" : ["ChargeItem.service",
"MedicationStatement.part-of",
"Observation.part-of"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "Returns dispenses with this external identifier"
},
{
"name" : "performer",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationDispense-performer",
"type" : "reference",
"documentation" : "Returns dispenses performed by a specific individual"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "Returns dispenses of this medicine code"
},
{
"name" : "receiver",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationDispense-receiver",
"type" : "reference",
"documentation" : "The identity of a receiver to list dispenses for"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationDispense-subject",
"type" : "reference",
"documentation" : "The identity of a patient for whom to list dispenses"
},
{
"name" : "destination",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationDispense-destination",
"type" : "reference",
"documentation" : "Returns dispenses that should be sent to a specific destination"
},
{
"name" : "medication",
"definition" : "http://hl7.org/fhir/SearchParameter/medications-medication",
"type" : "reference",
"documentation" : "Returns dispenses of this medicine resource"
},
{
"name" : "responsibleparty",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationDispense-responsibleparty",
"type" : "reference",
"documentation" : "Returns dispenses with the specified responsible party"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationDispense-type",
"type" : "token",
"documentation" : "Returns dispenses of a specific type"
},
{
"name" : "whenhandedover",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationDispense-whenhandedover",
"type" : "date",
"documentation" : "Returns dispenses handed over on this date"
},
{
"name" : "whenprepared",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationDispense-whenprepared",
"type" : "date",
"documentation" : "Returns dispenses prepared on this date"
},
{
"name" : "prescription",
"definition" : "http://hl7.org/fhir/SearchParameter/medications-prescription",
"type" : "reference",
"documentation" : "The identity of a prescription to list dispenses from"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The identity of a patient to list dispenses for"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationDispense-context",
"type" : "reference",
"documentation" : "Returns dispenses with a specific context (episode or episode of care)"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/medications-status",
"type" : "token",
"documentation" : "Returns dispenses with a specified dispense status"
}]
},
{
"type" : "MedicationKnowledge",
"profile" : "http://hl7.org/fhir/StructureDefinition/MedicationKnowledge",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["MedicationKnowledge.ingredient",
"MedicationKnowledge.manufacturer",
"MedicationKnowledge.monograph"],
"searchParam" : [{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationKnowledge-code",
"type" : "token",
"documentation" : "Code that identifies this medication"
},
{
"name" : "ingredient",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationKnowledge-ingredient",
"type" : "reference",
"documentation" : "Medication(s) or substance(s) contained in the medication"
},
{
"name" : "doseform",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationKnowledge-doseform",
"type" : "token",
"documentation" : "powder | tablets | capsule +"
},
{
"name" : "classification-type",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationKnowledge-classification-type",
"type" : "token",
"documentation" : "The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)"
},
{
"name" : "monograph-type",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationKnowledge-monograph-type",
"type" : "token",
"documentation" : "The category of medication document"
},
{
"name" : "classification",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationKnowledge-classification",
"type" : "token",
"documentation" : "Specific category assigned to the medication"
},
{
"name" : "manufacturer",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationKnowledge-manufacturer",
"type" : "reference",
"documentation" : "Manufacturer of the item"
},
{
"name" : "ingredient-code",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationKnowledge-ingredient-code",
"type" : "token",
"documentation" : "Medication(s) or substance(s) contained in the medication"
},
{
"name" : "source-cost",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationKnowledge-source-cost",
"type" : "token",
"documentation" : "The source or owner for the price information"
},
{
"name" : "monograph",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationKnowledge-monograph",
"type" : "reference",
"documentation" : "Associated documentation about the medication"
},
{
"name" : "monitoring-program-name",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationKnowledge-monitoring-program-name",
"type" : "token",
"documentation" : "Name of the reviewing program"
},
{
"name" : "monitoring-program-type",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationKnowledge-monitoring-program-type",
"type" : "token",
"documentation" : "Type of program under which the medication is monitored"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationKnowledge-status",
"type" : "token",
"documentation" : "active | inactive | entered-in-error"
}]
},
{
"type" : "MedicationRequest",
"profile" : "http://hl7.org/fhir/StructureDefinition/MedicationRequest",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["MedicationRequest.requester",
"MedicationRequest.intended-dispenser",
"MedicationRequest.subject",
"MedicationRequest.medication",
"MedicationRequest.encounter",
"MedicationRequest.patient",
"MedicationRequest.intended-performer"],
"searchRevInclude" : ["CarePlan.activity-reference",
"DiagnosticReport.based-on",
"MedicationAdministration.request",
"MedicationDispense.prescription",
"Observation.based-on",
"ServiceRequest.based-on"],
"searchParam" : [{
"name" : "requester",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationRequest-requester",
"type" : "reference",
"documentation" : "Returns prescriptions prescribed by this prescriber"
},
{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/medications-date",
"type" : "date",
"documentation" : "Returns medication request to be administered on a specific date"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "Return prescriptions with this external identifier"
},
{
"name" : "intended-dispenser",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationRequest-intended-dispenser",
"type" : "reference",
"documentation" : "Returns prescriptions intended to be dispensed by this Organization"
},
{
"name" : "authoredon",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationRequest-authoredon",
"type" : "date",
"documentation" : "Return prescriptions written on this date"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "Return prescriptions of this medication code"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationRequest-subject",
"type" : "reference",
"documentation" : "The identity of a patient to list orders for"
},
{
"name" : "medication",
"definition" : "http://hl7.org/fhir/SearchParameter/medications-medication",
"type" : "reference",
"documentation" : "Return prescriptions for this medication reference"
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/medications-encounter",
"type" : "reference",
"documentation" : "Return prescriptions with this encounter identifier"
},
{
"name" : "priority",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationRequest-priority",
"type" : "token",
"documentation" : "Returns prescriptions with different priorities"
},
{
"name" : "intent",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationRequest-intent",
"type" : "token",
"documentation" : "Returns prescriptions with different intents"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Returns prescriptions for a specific patient"
},
{
"name" : "intended-performer",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationRequest-intended-performer",
"type" : "reference",
"documentation" : "Returns the intended performer of the administration of the medication request"
},
{
"name" : "intended-performertype",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationRequest-intended-performertype",
"type" : "token",
"documentation" : "Returns requests for a specific type of performer"
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationRequest-category",
"type" : "token",
"documentation" : "Returns prescriptions with different categories"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/medications-status",
"type" : "token",
"documentation" : "Status of the prescription"
}]
},
{
"type" : "MedicationStatement",
"profile" : "http://hl7.org/fhir/StructureDefinition/MedicationStatement",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["MedicationStatement.subject",
"MedicationStatement.patient",
"MedicationStatement.context",
"MedicationStatement.medication",
"MedicationStatement.part-of",
"MedicationStatement.source"],
"searchRevInclude" : ["AdverseEvent.substance",
"MedicationStatement.part-of",
"Observation.part-of"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "Return statements with this external identifier"
},
{
"name" : "effective",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationStatement-effective",
"type" : "date",
"documentation" : "Date when patient was taking (or not taking) the medication"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "Return statements of this medication code"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationStatement-subject",
"type" : "reference",
"documentation" : "The identity of a patient, animal or group to list statements for"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Returns statements for a specific patient."
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationStatement-context",
"type" : "reference",
"documentation" : "Returns statements for a specific context (episode or episode of Care)."
},
{
"name" : "medication",
"definition" : "http://hl7.org/fhir/SearchParameter/medications-medication",
"type" : "reference",
"documentation" : "Return statements of this medication reference"
},
{
"name" : "part-of",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationStatement-part-of",
"type" : "reference",
"documentation" : "Returns statements that are part of another event."
},
{
"name" : "source",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationStatement-source",
"type" : "reference",
"documentation" : "Who or where the information in the statement came from"
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationStatement-category",
"type" : "token",
"documentation" : "Returns statements of this category of medicationstatement"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/medications-status",
"type" : "token",
"documentation" : "Return statements that match the given status"
}]
},
{
"type" : "MedicinalProduct",
"profile" : "http://hl7.org/fhir/StructureDefinition/MedicinalProduct",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchRevInclude" : ["MedicinalProductAuthorization.subject",
"MedicinalProductContraindication.subject",
"MedicinalProductIndication.subject",
"MedicinalProductInteraction.subject",
"MedicinalProductPackaged.subject",
"MedicinalProductUndesirableEffect.subject"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicinalProduct-identifier",
"type" : "token",
"documentation" : "Business identifier for this product. Could be an MPID"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicinalProduct-name",
"type" : "string",
"documentation" : "The full product name"
},
{
"name" : "name-language",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicinalProduct-name-language",
"type" : "token",
"documentation" : "Language code for this name"
}]
},
{
"type" : "MedicinalProductAuthorization",
"profile" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductAuthorization",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["MedicinalProductAuthorization.subject",
"MedicinalProductAuthorization.holder"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicinalProductAuthorization-identifier",
"type" : "token",
"documentation" : "Business identifier for the marketing authorization, as assigned by a regulator"
},
{
"name" : "country",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicinalProductAuthorization-country",
"type" : "token",
"documentation" : "The country in which the marketing authorization has been granted"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicinalProductAuthorization-subject",
"type" : "reference",
"documentation" : "The medicinal product that is being authorized"
},
{
"name" : "holder",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicinalProductAuthorization-holder",
"type" : "reference",
"documentation" : "Marketing Authorization Holder"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicinalProductAuthorization-status",
"type" : "token",
"documentation" : "The status of the marketing authorization"
}]
},
{
"type" : "MedicinalProductContraindication",
"profile" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductContraindication",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["MedicinalProductContraindication.subject"],
"searchParam" : [{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicinalProductContraindication-subject",
"type" : "reference",
"documentation" : "The medication for which this is an contraindication"
}]
},
{
"type" : "MedicinalProductIndication",
"profile" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductIndication",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["MedicinalProductIndication.subject"],
"searchParam" : [{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicinalProductIndication-subject",
"type" : "reference",
"documentation" : "The medication for which this is an indication"
}]
},
{
"type" : "MedicinalProductIngredient",
"profile" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductIngredient",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"]
},
{
"type" : "MedicinalProductInteraction",
"profile" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductInteraction",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["MedicinalProductInteraction.subject"],
"searchParam" : [{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicinalProductInteraction-subject",
"type" : "reference",
"documentation" : "The medication for which this is an interaction"
}]
},
{
"type" : "MedicinalProductManufactured",
"profile" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductManufactured",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"]
},
{
"type" : "MedicinalProductPackaged",
"profile" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductPackaged",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["MedicinalProductPackaged.subject"],
"searchRevInclude" : ["MedicinalProductAuthorization.subject"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicinalProductPackaged-identifier",
"type" : "token",
"documentation" : "Unique identifier"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicinalProductPackaged-subject",
"type" : "reference",
"documentation" : "The product with this is a pack for"
}]
},
{
"type" : "MedicinalProductPharmaceutical",
"profile" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductPharmaceutical",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicinalProductPharmaceutical-identifier",
"type" : "token",
"documentation" : "An identifier for the pharmaceutical medicinal product"
},
{
"name" : "route",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicinalProductPharmaceutical-route",
"type" : "token",
"documentation" : "Coded expression for the route"
},
{
"name" : "target-species",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicinalProductPharmaceutical-target-species",
"type" : "token",
"documentation" : "Coded expression for the species"
}]
},
{
"type" : "MedicinalProductUndesirableEffect",
"profile" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductUndesirableEffect",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["MedicinalProductUndesirableEffect.subject"],
"searchParam" : [{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicinalProductUndesirableEffect-subject",
"type" : "reference",
"documentation" : "The medication for which this is an undesirable effect"
}]
},
{
"type" : "MessageDefinition",
"profile" : "http://hl7.org/fhir/StructureDefinition/MessageDefinition",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["MessageDefinition.parent"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-date",
"type" : "date",
"documentation" : "The message definition publication date"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-identifier",
"type" : "token",
"documentation" : "External identifier for the message definition"
},
{
"name" : "parent",
"definition" : "http://hl7.org/fhir/SearchParameter/MessageDefinition-parent",
"type" : "reference",
"documentation" : "A resource that is the parent of the definition"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the message definition"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the message definition"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-description",
"type" : "string",
"documentation" : "The description of the message definition"
},
{
"name" : "focus",
"definition" : "http://hl7.org/fhir/SearchParameter/MessageDefinition-focus",
"type" : "token",
"documentation" : "A resource that is a permitted focus of the message"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the message definition"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-title",
"type" : "string",
"documentation" : "The human-friendly name of the message definition"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-version",
"type" : "token",
"documentation" : "The business version of the message definition"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-url",
"type" : "uri",
"documentation" : "The uri that identifies the message definition"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the message definition"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-name",
"type" : "string",
"documentation" : "Computationally friendly name of the message definition"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context",
"type" : "token",
"documentation" : "A use context assigned to the message definition"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the message definition"
},
{
"name" : "event",
"definition" : "http://hl7.org/fhir/SearchParameter/MessageDefinition-event",
"type" : "token",
"documentation" : "The event that triggers the message or link to the event definition."
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/MessageDefinition-category",
"type" : "token",
"documentation" : "The behavior associated with the message"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the message definition"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-status",
"type" : "token",
"documentation" : "The current status of the message definition"
}]
},
{
"type" : "MessageHeader",
"profile" : "http://hl7.org/fhir/StructureDefinition/MessageHeader",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["MessageHeader.receiver",
"MessageHeader.author",
"MessageHeader.focus",
"MessageHeader.target",
"MessageHeader.sender",
"MessageHeader.responsible",
"MessageHeader.enterer"],
"searchParam" : [{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/MessageHeader-code",
"type" : "token",
"documentation" : "ok | transient-error | fatal-error"
},
{
"name" : "receiver",
"definition" : "http://hl7.org/fhir/SearchParameter/MessageHeader-receiver",
"type" : "reference",
"documentation" : "Intended \"real-world\" recipient for the data"
},
{
"name" : "author",
"definition" : "http://hl7.org/fhir/SearchParameter/MessageHeader-author",
"type" : "reference",
"documentation" : "The source of the decision"
},
{
"name" : "destination",
"definition" : "http://hl7.org/fhir/SearchParameter/MessageHeader-destination",
"type" : "string",
"documentation" : "Name of system"
},
{
"name" : "focus",
"definition" : "http://hl7.org/fhir/SearchParameter/MessageHeader-focus",
"type" : "reference",
"documentation" : "The actual content of the message"
},
{
"name" : "source",
"definition" : "http://hl7.org/fhir/SearchParameter/MessageHeader-source",
"type" : "string",
"documentation" : "Name of system"
},
{
"name" : "target",
"definition" : "http://hl7.org/fhir/SearchParameter/MessageHeader-target",
"type" : "reference",
"documentation" : "Particular delivery destination within the destination"
},
{
"name" : "destination-uri",
"definition" : "http://hl7.org/fhir/SearchParameter/MessageHeader-destination-uri",
"type" : "uri",
"documentation" : "Actual destination address or id"
},
{
"name" : "source-uri",
"definition" : "http://hl7.org/fhir/SearchParameter/MessageHeader-source-uri",
"type" : "uri",
"documentation" : "Actual message source address or id"
},
{
"name" : "sender",
"definition" : "http://hl7.org/fhir/SearchParameter/MessageHeader-sender",
"type" : "reference",
"documentation" : "Real world sender of the message"
},
{
"name" : "responsible",
"definition" : "http://hl7.org/fhir/SearchParameter/MessageHeader-responsible",
"type" : "reference",
"documentation" : "Final responsibility for event"
},
{
"name" : "enterer",
"definition" : "http://hl7.org/fhir/SearchParameter/MessageHeader-enterer",
"type" : "reference",
"documentation" : "The source of the data entry"
},
{
"name" : "response-id",
"definition" : "http://hl7.org/fhir/SearchParameter/MessageHeader-response-id",
"type" : "token",
"documentation" : "Id of original message"
},
{
"name" : "event",
"definition" : "http://hl7.org/fhir/SearchParameter/MessageHeader-event",
"type" : "token",
"documentation" : "Code for the event this message represents or link to event definition"
}]
},
{
"type" : "MolecularSequence",
"profile" : "http://hl7.org/fhir/StructureDefinition/MolecularSequence",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["MolecularSequence.patient"],
"searchRevInclude" : ["Observation.derived-from",
"Observation.has-member"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/MolecularSequence-identifier",
"type" : "token",
"documentation" : "The unique identity for a particular sequence"
},
{
"name" : "referenceseqid-variant-coordinate",
"definition" : "http://hl7.org/fhir/SearchParameter/MolecularSequence-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",
"definition" : "http://hl7.org/fhir/SearchParameter/MolecularSequence-chromosome",
"type" : "token",
"documentation" : "Chromosome number of the reference sequence"
},
{
"name" : "window-end",
"definition" : "http://hl7.org/fhir/SearchParameter/MolecularSequence-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",
"definition" : "http://hl7.org/fhir/SearchParameter/MolecularSequence-type",
"type" : "token",
"documentation" : "Amino Acid Sequence/ DNA Sequence / RNA Sequence"
},
{
"name" : "window-start",
"definition" : "http://hl7.org/fhir/SearchParameter/MolecularSequence-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",
"definition" : "http://hl7.org/fhir/SearchParameter/MolecularSequence-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",
"definition" : "http://hl7.org/fhir/SearchParameter/MolecularSequence-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",
"definition" : "http://hl7.org/fhir/SearchParameter/MolecularSequence-patient",
"type" : "reference",
"documentation" : "The subject that the observation is about"
},
{
"name" : "variant-start",
"definition" : "http://hl7.org/fhir/SearchParameter/MolecularSequence-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",
"definition" : "http://hl7.org/fhir/SearchParameter/MolecularSequence-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",
"definition" : "http://hl7.org/fhir/SearchParameter/MolecularSequence-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",
"definition" : "http://hl7.org/fhir/SearchParameter/MolecularSequence-referenceseqid",
"type" : "token",
"documentation" : "Reference Sequence of the sequence"
}]
},
{
"type" : "NamingSystem",
"profile" : "http://hl7.org/fhir/StructureDefinition/NamingSystem",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-date",
"type" : "date",
"documentation" : "The naming system publication date"
},
{
"name" : "period",
"definition" : "http://hl7.org/fhir/SearchParameter/NamingSystem-period",
"type" : "date",
"documentation" : "When is identifier valid?"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the naming system"
},
{
"name" : "kind",
"definition" : "http://hl7.org/fhir/SearchParameter/NamingSystem-kind",
"type" : "token",
"documentation" : "codesystem | identifier | root"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the naming system"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-description",
"type" : "string",
"documentation" : "The description of the naming system"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the naming system"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/NamingSystem-type",
"type" : "token",
"documentation" : "e.g. driver, provider, patient, bank etc."
},
{
"name" : "id-type",
"definition" : "http://hl7.org/fhir/SearchParameter/NamingSystem-id-type",
"type" : "token",
"documentation" : "oid | uuid | uri | other"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the naming system"
},
{
"name" : "responsible",
"definition" : "http://hl7.org/fhir/SearchParameter/NamingSystem-responsible",
"type" : "string",
"documentation" : "Who maintains system namespace?"
},
{
"name" : "contact",
"definition" : "http://hl7.org/fhir/SearchParameter/NamingSystem-contact",
"type" : "string",
"documentation" : "Name of an individual to contact"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-name",
"type" : "string",
"documentation" : "Computationally friendly name of the naming system"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context",
"type" : "token",
"documentation" : "A use context assigned to the naming system"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the naming system"
},
{
"name" : "telecom",
"definition" : "http://hl7.org/fhir/SearchParameter/NamingSystem-telecom",
"type" : "token",
"documentation" : "Contact details for individual or organization"
},
{
"name" : "value",
"definition" : "http://hl7.org/fhir/SearchParameter/NamingSystem-value",
"type" : "string",
"documentation" : "The unique identifier"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the naming system"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-status",
"type" : "token",
"documentation" : "The current status of the naming system"
}]
},
{
"type" : "NutritionOrder",
"profile" : "http://hl7.org/fhir/StructureDefinition/NutritionOrder",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["NutritionOrder.provider",
"NutritionOrder.patient",
"NutritionOrder.instantiates-canonical",
"NutritionOrder.encounter"],
"searchRevInclude" : ["CarePlan.activity-reference",
"DiagnosticReport.based-on",
"Observation.based-on"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "Return nutrition orders with this external identifier"
},
{
"name" : "datetime",
"definition" : "http://hl7.org/fhir/SearchParameter/NutritionOrder-datetime",
"type" : "date",
"documentation" : "Return nutrition orders requested on this date"
},
{
"name" : "provider",
"definition" : "http://hl7.org/fhir/SearchParameter/NutritionOrder-provider",
"type" : "reference",
"documentation" : "The identity of the provider who placed the nutrition order"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The identity of the person who requires the diet, formula or nutritional supplement"
},
{
"name" : "supplement",
"definition" : "http://hl7.org/fhir/SearchParameter/NutritionOrder-supplement",
"type" : "token",
"documentation" : "Type of supplement product requested"
},
{
"name" : "formula",
"definition" : "http://hl7.org/fhir/SearchParameter/NutritionOrder-formula",
"type" : "token",
"documentation" : "Type of enteral or infant formula"
},
{
"name" : "instantiates-canonical",
"definition" : "http://hl7.org/fhir/SearchParameter/NutritionOrder-instantiates-canonical",
"type" : "reference",
"documentation" : "Instantiates FHIR protocol or definition"
},
{
"name" : "instantiates-uri",
"definition" : "http://hl7.org/fhir/SearchParameter/NutritionOrder-instantiates-uri",
"type" : "uri",
"documentation" : "Instantiates external protocol or definition"
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type" : "reference",
"documentation" : "Return nutrition orders with this encounter identifier"
},
{
"name" : "oraldiet",
"definition" : "http://hl7.org/fhir/SearchParameter/NutritionOrder-oraldiet",
"type" : "token",
"documentation" : "Type of diet that can be consumed orally (i.e., take via the mouth)."
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/NutritionOrder-status",
"type" : "token",
"documentation" : "Status of the nutrition order."
},
{
"name" : "additive",
"definition" : "http://hl7.org/fhir/SearchParameter/NutritionOrder-additive",
"type" : "token",
"documentation" : "Type of module component to add to the feeding"
}]
},
{
"type" : "Observation",
"profile" : "http://hl7.org/fhir/StructureDefinition/Observation",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Observation.subject",
"Observation.focus",
"Observation.derived-from",
"Observation.part-of",
"Observation.has-member",
"Observation.based-on",
"Observation.patient",
"Observation.specimen",
"Observation.performer",
"Observation.encounter",
"Observation.device"],
"searchRevInclude" : ["Appointment.reason-reference",
"ChargeItem.service",
"ClinicalImpression.finding-ref",
"ClinicalImpression.investigation",
"DiagnosticReport.result",
"Encounter.reason-reference",
"Immunization.reaction",
"Immunization.reason-reference",
"MedicationStatement.part-of",
"Observation.derived-from",
"Observation.has-member",
"Procedure.part-of",
"Procedure.reason-reference",
"QuestionnaireResponse.part-of"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "Obtained date/time. If the obtained element is a period, a date that falls in the period"
},
{
"name" : "combo-data-absent-reason",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-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",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "The code of the observation type"
},
{
"name" : "combo-code-value-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-combo-code-value-quantity",
"type" : "composite",
"documentation" : "Code and quantity value parameter pair, including in components"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-subject",
"type" : "reference",
"documentation" : "The subject that the observation is about"
},
{
"name" : "component-data-absent-reason",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-component-data-absent-reason",
"type" : "token",
"documentation" : "The reason why the expected value in the element Observation.component.value[x] is missing."
},
{
"name" : "value-concept",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-value-concept",
"type" : "token",
"documentation" : "The value of the observation, if the value is a CodeableConcept"
},
{
"name" : "value-date",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-value-date",
"type" : "date",
"documentation" : "The value of the observation, if the value is a date or period of time"
},
{
"name" : "focus",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-focus",
"type" : "reference",
"documentation" : "The focus of an observation when the focus is not the patient of record."
},
{
"name" : "derived-from",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-derived-from",
"type" : "reference",
"documentation" : "Related measurements the observation is made from"
},
{
"name" : "part-of",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-part-of",
"type" : "reference",
"documentation" : "Part of referenced event"
},
{
"name" : "has-member",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-has-member",
"type" : "reference",
"documentation" : "Related resource that belongs to the Observation group"
},
{
"name" : "code-value-string",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-code-value-string",
"type" : "composite",
"documentation" : "Code and string value parameter pair"
},
{
"name" : "component-code-value-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-component-code-value-quantity",
"type" : "composite",
"documentation" : "Component code and component quantity value parameter pair"
},
{
"name" : "based-on",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-based-on",
"type" : "reference",
"documentation" : "Reference to the service request."
},
{
"name" : "code-value-date",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-code-value-date",
"type" : "composite",
"documentation" : "Code and date/time value parameter pair"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The subject that the observation is about (if patient)"
},
{
"name" : "specimen",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-specimen",
"type" : "reference",
"documentation" : "Specimen used for this observation"
},
{
"name" : "component-code",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-component-code",
"type" : "token",
"documentation" : "The component code of the observation type"
},
{
"name" : "code-value-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-code-value-quantity",
"type" : "composite",
"documentation" : "Code and quantity value parameter pair"
},
{
"name" : "combo-code-value-concept",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-combo-code-value-concept",
"type" : "composite",
"documentation" : "Code and coded value parameter pair, including in components"
},
{
"name" : "value-string",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-value-string",
"type" : "string",
"documentation" : "The value of the observation, if the value is a string, and also searches in CodeableConcept.text"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "The unique id for a particular observation"
},
{
"name" : "performer",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-performer",
"type" : "reference",
"documentation" : "Who performed the observation"
},
{
"name" : "combo-code",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-combo-code",
"type" : "token",
"documentation" : "The code of the observation type or component type"
},
{
"name" : "method",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-method",
"type" : "token",
"documentation" : "The method used for the observation"
},
{
"name" : "value-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-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",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-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",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-data-absent-reason",
"type" : "token",
"documentation" : "The reason why the expected value in the element Observation.value[x] is missing."
},
{
"name" : "combo-value-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-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",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type" : "reference",
"documentation" : "Encounter related to the observation"
},
{
"name" : "code-value-concept",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-code-value-concept",
"type" : "composite",
"documentation" : "Code and coded value parameter pair"
},
{
"name" : "component-code-value-concept",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-component-code-value-concept",
"type" : "composite",
"documentation" : "Component code and component coded value parameter pair"
},
{
"name" : "component-value-concept",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-component-value-concept",
"type" : "token",
"documentation" : "The value of the component observation, if the value is a CodeableConcept"
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-category",
"type" : "token",
"documentation" : "The classification of the type of observation"
},
{
"name" : "device",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-device",
"type" : "reference",
"documentation" : "The Device that generated the observation data."
},
{
"name" : "combo-value-concept",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-combo-value-concept",
"type" : "token",
"documentation" : "The value or component value of the observation, if the value is a CodeableConcept"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-status",
"type" : "token",
"documentation" : "The status of the observation"
}]
},
{
"type" : "ObservationDefinition",
"profile" : "http://hl7.org/fhir/StructureDefinition/ObservationDefinition",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"]
},
{
"type" : "OperationDefinition",
"profile" : "http://hl7.org/fhir/StructureDefinition/OperationDefinition",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["OperationDefinition.input-profile",
"OperationDefinition.output-profile",
"OperationDefinition.base"],
"searchRevInclude" : ["CarePlan.instantiates-canonical",
"Communication.instantiates-canonical",
"FamilyMemberHistory.instantiates-canonical",
"OperationDefinition.base",
"Procedure.instantiates-canonical"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-date",
"type" : "date",
"documentation" : "The operation definition publication date"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/OperationDefinition-code",
"type" : "token",
"documentation" : "Name used to invoke the operation"
},
{
"name" : "instance",
"definition" : "http://hl7.org/fhir/SearchParameter/OperationDefinition-instance",
"type" : "token",
"documentation" : "Invoke on an instance?"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the operation definition"
},
{
"name" : "kind",
"definition" : "http://hl7.org/fhir/SearchParameter/OperationDefinition-kind",
"type" : "token",
"documentation" : "operation | query"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the operation definition"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-description",
"type" : "string",
"documentation" : "The description of the operation definition"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the operation definition"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-title",
"type" : "string",
"documentation" : "The human-friendly name of the operation definition"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/OperationDefinition-type",
"type" : "token",
"documentation" : "Invoke at the type level?"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-version",
"type" : "token",
"documentation" : "The business version of the operation definition"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-url",
"type" : "uri",
"documentation" : "The uri that identifies the operation definition"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the operation definition"
},
{
"name" : "input-profile",
"definition" : "http://hl7.org/fhir/SearchParameter/OperationDefinition-input-profile",
"type" : "reference",
"documentation" : "Validation information for in parameters"
},
{
"name" : "output-profile",
"definition" : "http://hl7.org/fhir/SearchParameter/OperationDefinition-output-profile",
"type" : "reference",
"documentation" : "Validation information for out parameters"
},
{
"name" : "system",
"definition" : "http://hl7.org/fhir/SearchParameter/OperationDefinition-system",
"type" : "token",
"documentation" : "Invoke at the system level?"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-name",
"type" : "string",
"documentation" : "Computationally friendly name of the operation definition"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context",
"type" : "token",
"documentation" : "A use context assigned to the operation definition"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the operation definition"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the operation definition"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-status",
"type" : "token",
"documentation" : "The current status of the operation definition"
},
{
"name" : "base",
"definition" : "http://hl7.org/fhir/SearchParameter/OperationDefinition-base",
"type" : "reference",
"documentation" : "Marks this as a profile of the base"
}]
},
{
"type" : "OperationOutcome",
"profile" : "http://hl7.org/fhir/StructureDefinition/OperationOutcome",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"]
},
{
"type" : "Organization",
"profile" : "http://hl7.org/fhir/StructureDefinition/Organization",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Organization.partof",
"Organization.endpoint"],
"searchRevInclude" : ["Account.owner",
"Account.subject",
"Account.patient",
"AuditEvent.agent",
"AuditEvent.source",
"AuditEvent.patient",
"Basic.author",
"CarePlan.performer",
"CareTeam.participant",
"ChargeItem.performing-organization",
"ChargeItem.enterer",
"ChargeItem.performer-actor",
"ChargeItem.requesting-organization",
"Claim.care-team",
"Claim.payee",
"Claim.provider",
"Claim.insurer",
"ClaimResponse.insurer",
"ClaimResponse.requestor",
"Communication.sender",
"Communication.recipient",
"CommunicationRequest.requester",
"CommunicationRequest.sender",
"CommunicationRequest.recipient",
"Composition.author",
"Composition.attester",
"Consent.actor",
"Consent.organization",
"Consent.consentor",
"Contract.authority",
"Contract.signer",
"Coverage.payor",
"Coverage.policy-holder",
"CoverageEligibilityRequest.provider",
"CoverageEligibilityResponse.insurer",
"CoverageEligibilityResponse.requestor",
"Device.organization",
"DeviceRequest.requester",
"DeviceRequest.performer",
"DiagnosticReport.performer",
"DiagnosticReport.results-interpreter",
"DocumentManifest.author",
"DocumentManifest.recipient",
"DocumentReference.authenticator",
"DocumentReference.custodian",
"DocumentReference.author",
"Encounter.service-provider",
"Endpoint.organization",
"EpisodeOfCare.organization",
"ExplanationOfBenefit.care-team",
"ExplanationOfBenefit.payee",
"ExplanationOfBenefit.provider",
"Flag.subject",
"Flag.patient",
"Flag.author",
"Goal.patient",
"Goal.subject",
"Group.managing-entity",
"HealthcareService.organization",
"ImagingStudy.performer",
"Immunization.performer",
"Immunization.manufacturer",
"InsurancePlan.owned-by",
"InsurancePlan.administered-by",
"Invoice.issuer",
"Invoice.participant",
"Invoice.recipient",
"Linkage.author",
"Location.organization",
"MeasureReport.reporter",
"Media.operator",
"Medication.manufacturer",
"MedicationDispense.performer",
"MedicationKnowledge.manufacturer",
"MedicationRequest.requester",
"MedicationRequest.intended-dispenser",
"MedicationRequest.intended-performer",
"MedicationStatement.source",
"MedicinalProductAuthorization.holder",
"MessageHeader.receiver",
"MessageHeader.sender",
"MessageHeader.responsible",
"Observation.performer",
"Organization.partof",
"OrganizationAffiliation.primary-organization",
"OrganizationAffiliation.network",
"OrganizationAffiliation.participating-organization",
"Patient.general-practitioner",
"Patient.organization",
"PaymentNotice.provider",
"PaymentReconciliation.payment-issuer",
"PaymentReconciliation.requestor",
"Person.organization",
"PractitionerRole.organization",
"Procedure.performer",
"Provenance.agent",
"QuestionnaireResponse.author",
"ResearchStudy.sponsor",
"ServiceRequest.requester",
"ServiceRequest.performer",
"SupplyDelivery.supplier",
"SupplyRequest.requester",
"SupplyRequest.subject",
"SupplyRequest.supplier",
"Task.owner",
"Task.requester"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Organization-identifier",
"type" : "token",
"documentation" : "Any identifier for the organization (not the accreditation issuer's identifier)"
},
{
"name" : "partof",
"definition" : "http://hl7.org/fhir/SearchParameter/Organization-partof",
"type" : "reference",
"documentation" : "An organization of which this organization forms a part"
},
{
"name" : "address",
"definition" : "http://hl7.org/fhir/SearchParameter/Organization-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",
"definition" : "http://hl7.org/fhir/SearchParameter/Organization-address-state",
"type" : "string",
"documentation" : "A state specified in an address"
},
{
"name" : "active",
"definition" : "http://hl7.org/fhir/SearchParameter/Organization-active",
"type" : "token",
"documentation" : "Is the Organization record active"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/Organization-type",
"type" : "token",
"documentation" : "A code for the type of organization"
},
{
"name" : "address-postalcode",
"definition" : "http://hl7.org/fhir/SearchParameter/Organization-address-postalcode",
"type" : "string",
"documentation" : "A postal code specified in an address"
},
{
"name" : "address-country",
"definition" : "http://hl7.org/fhir/SearchParameter/Organization-address-country",
"type" : "string",
"documentation" : "A country specified in an address"
},
{
"name" : "endpoint",
"definition" : "http://hl7.org/fhir/SearchParameter/Organization-endpoint",
"type" : "reference",
"documentation" : "Technical endpoints providing access to services operated for the organization"
},
{
"name" : "phonetic",
"definition" : "http://hl7.org/fhir/SearchParameter/Organization-phonetic",
"type" : "string",
"documentation" : "A portion of the organization's name using some kind of phonetic matching algorithm"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/Organization-name",
"type" : "string",
"documentation" : "A portion of the organization's name or alias"
},
{
"name" : "address-use",
"definition" : "http://hl7.org/fhir/SearchParameter/Organization-address-use",
"type" : "token",
"documentation" : "A use code specified in an address"
},
{
"name" : "address-city",
"definition" : "http://hl7.org/fhir/SearchParameter/Organization-address-city",
"type" : "string",
"documentation" : "A city specified in an address"
}]
},
{
"type" : "OrganizationAffiliation",
"profile" : "http://hl7.org/fhir/StructureDefinition/OrganizationAffiliation",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["OrganizationAffiliation.primary-organization",
"OrganizationAffiliation.network",
"OrganizationAffiliation.endpoint",
"OrganizationAffiliation.service",
"OrganizationAffiliation.participating-organization",
"OrganizationAffiliation.location"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-date",
"type" : "date",
"documentation" : "The period during which the participatingOrganization is affiliated with the primary organization"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-identifier",
"type" : "token",
"documentation" : "An organization affiliation's Identifier"
},
{
"name" : "specialty",
"definition" : "http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-specialty",
"type" : "token",
"documentation" : "Specific specialty of the participatingOrganization in the context of the role"
},
{
"name" : "role",
"definition" : "http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-role",
"type" : "token",
"documentation" : "Definition of the role the participatingOrganization plays"
},
{
"name" : "active",
"definition" : "http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-active",
"type" : "token",
"documentation" : "Whether this organization affiliation record is in active use"
},
{
"name" : "primary-organization",
"definition" : "http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-primary-organization",
"type" : "reference",
"documentation" : "The organization that receives the services from the participating organization"
},
{
"name" : "network",
"definition" : "http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-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",
"definition" : "http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-endpoint",
"type" : "reference",
"documentation" : "Technical endpoints providing access to services operated for this role"
},
{
"name" : "phone",
"definition" : "http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-phone",
"type" : "token",
"documentation" : "A value in a phone contact"
},
{
"name" : "service",
"definition" : "http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-service",
"type" : "reference",
"documentation" : "Healthcare services provided through the role"
},
{
"name" : "participating-organization",
"definition" : "http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-participating-organization",
"type" : "reference",
"documentation" : "The organization that provides services to the primary organization"
},
{
"name" : "telecom",
"definition" : "http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-telecom",
"type" : "token",
"documentation" : "The value in any kind of contact"
},
{
"name" : "location",
"definition" : "http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-location",
"type" : "reference",
"documentation" : "The location(s) at which the role occurs"
},
{
"name" : "email",
"definition" : "http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-email",
"type" : "token",
"documentation" : "A value in an email contact"
}]
},
{
"type" : "Patient",
"profile" : "http://hl7.org/fhir/StructureDefinition/Patient",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Patient.general-practitioner",
"Patient.link",
"Patient.organization"],
"searchRevInclude" : ["Account.subject",
"Account.patient",
"AdverseEvent.recorder",
"AdverseEvent.subject",
"AllergyIntolerance.recorder",
"AllergyIntolerance.asserter",
"AllergyIntolerance.patient",
"Appointment.practitioner",
"Appointment.actor",
"Appointment.patient",
"Appointment.location",
"AppointmentResponse.actor",
"AppointmentResponse.practitioner",
"AppointmentResponse.patient",
"AppointmentResponse.location",
"AuditEvent.agent",
"AuditEvent.source",
"AuditEvent.patient",
"Basic.author",
"BodyStructure.patient",
"CarePlan.performer",
"CarePlan.subject",
"CarePlan.patient",
"CareTeam.patient",
"CareTeam.subject",
"CareTeam.participant",
"ChargeItem.subject",
"ChargeItem.patient",
"ChargeItem.enterer",
"ChargeItem.performer-actor",
"Claim.payee",
"Claim.patient",
"ClaimResponse.patient",
"ClinicalImpression.subject",
"ClinicalImpression.patient",
"Communication.subject",
"Communication.sender",
"Communication.patient",
"Communication.recipient",
"CommunicationRequest.requester",
"CommunicationRequest.subject",
"CommunicationRequest.sender",
"CommunicationRequest.patient",
"CommunicationRequest.recipient",
"Composition.author",
"Composition.attester",
"Condition.subject",
"Condition.asserter",
"Condition.patient",
"Consent.actor",
"Consent.patient",
"Consent.consentor",
"Contract.signer",
"Coverage.payor",
"Coverage.subscriber",
"Coverage.beneficiary",
"Coverage.patient",
"Coverage.policy-holder",
"CoverageEligibilityRequest.patient",
"CoverageEligibilityResponse.patient",
"DetectedIssue.patient",
"Device.patient",
"DeviceRequest.performer",
"DeviceRequest.subject",
"DeviceRequest.patient",
"DeviceUseStatement.subject",
"DeviceUseStatement.patient",
"DiagnosticReport.subject",
"DiagnosticReport.patient",
"DocumentManifest.subject",
"DocumentManifest.author",
"DocumentManifest.patient",
"DocumentManifest.recipient",
"DocumentReference.subject",
"DocumentReference.patient",
"DocumentReference.author",
"Encounter.subject",
"Encounter.patient",
"EnrollmentRequest.subject",
"EnrollmentRequest.patient",
"EpisodeOfCare.patient",
"ExplanationOfBenefit.payee",
"ExplanationOfBenefit.patient",
"FamilyMemberHistory.patient",
"Flag.subject",
"Flag.patient",
"Flag.author",
"Goal.patient",
"Goal.subject",
"Group.member",
"GuidanceResponse.patient",
"GuidanceResponse.subject",
"ImagingStudy.performer",
"ImagingStudy.subject",
"ImagingStudy.patient",
"Immunization.patient",
"ImmunizationEvaluation.patient",
"ImmunizationRecommendation.patient",
"Invoice.subject",
"Invoice.participant",
"Invoice.patient",
"Invoice.recipient",
"List.subject",
"List.patient",
"List.source",
"MeasureReport.patient",
"MeasureReport.subject",
"Media.subject",
"Media.operator",
"Media.patient",
"MedicationAdministration.performer",
"MedicationAdministration.subject",
"MedicationAdministration.patient",
"MedicationDispense.performer",
"MedicationDispense.receiver",
"MedicationDispense.subject",
"MedicationDispense.patient",
"MedicationRequest.requester",
"MedicationRequest.subject",
"MedicationRequest.patient",
"MedicationRequest.intended-performer",
"MedicationStatement.subject",
"MedicationStatement.patient",
"MedicationStatement.source",
"MolecularSequence.patient",
"NutritionOrder.patient",
"Observation.subject",
"Observation.patient",
"Observation.performer",
"Patient.link",
"Person.practitioner",
"Person.link",
"Person.relatedperson",
"Person.patient",
"Procedure.performer",
"Procedure.subject",
"Procedure.patient",
"Provenance.agent",
"QuestionnaireResponse.author",
"QuestionnaireResponse.source",
"RelatedPerson.patient",
"RequestGroup.subject",
"RequestGroup.participant",
"RequestGroup.patient",
"ResearchSubject.individual",
"ResearchSubject.patient",
"RiskAssessment.subject",
"RiskAssessment.patient",
"Schedule.actor",
"ServiceRequest.requester",
"ServiceRequest.performer",
"ServiceRequest.subject",
"ServiceRequest.patient",
"Specimen.subject",
"Specimen.patient",
"SupplyDelivery.patient",
"SupplyRequest.requester",
"SupplyRequest.subject",
"Task.owner",
"Task.requester",
"VisionPrescription.patient"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-identifier",
"type" : "token",
"documentation" : "A patient identifier"
},
{
"name" : "given",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-given",
"type" : "string",
"documentation" : "A portion of the given name of the patient"
},
{
"name" : "address",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-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" : "birthdate",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-birthdate",
"type" : "date",
"documentation" : "The patient's date of birth"
},
{
"name" : "deceased",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-deceased",
"type" : "token",
"documentation" : "This patient has been marked as deceased, or as a death date entered"
},
{
"name" : "address-state",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-state",
"type" : "string",
"documentation" : "A state specified in an address"
},
{
"name" : "gender",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-gender",
"type" : "token",
"documentation" : "Gender of the patient"
},
{
"name" : "general-practitioner",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-general-practitioner",
"type" : "reference",
"documentation" : "Patient's nominated general practitioner, not the organization that manages the record"
},
{
"name" : "link",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-link",
"type" : "reference",
"documentation" : "All patients linked to the given patient"
},
{
"name" : "active",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-active",
"type" : "token",
"documentation" : "Whether the patient record is active"
},
{
"name" : "language",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-language",
"type" : "token",
"documentation" : "Language code (irrespective of use value)"
},
{
"name" : "address-postalcode",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-postalcode",
"type" : "string",
"documentation" : "A postalCode specified in an address"
},
{
"name" : "address-country",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-country",
"type" : "string",
"documentation" : "A country specified in an address"
},
{
"name" : "death-date",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-death-date",
"type" : "date",
"documentation" : "The date of death has been provided and satisfies this search value"
},
{
"name" : "phonetic",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-phonetic",
"type" : "string",
"documentation" : "A portion of either family or given name using some kind of phonetic matching algorithm"
},
{
"name" : "phone",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-phone",
"type" : "token",
"documentation" : "A value in a phone contact"
},
{
"name" : "organization",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-organization",
"type" : "reference",
"documentation" : "The organization that is the custodian of the patient record"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-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",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-use",
"type" : "token",
"documentation" : "A use code specified in an address"
},
{
"name" : "telecom",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-telecom",
"type" : "token",
"documentation" : "The value in any kind of telecom details of the patient"
},
{
"name" : "family",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-family",
"type" : "string",
"documentation" : "A portion of the family name of the patient"
},
{
"name" : "address-city",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-city",
"type" : "string",
"documentation" : "A city specified in an address"
},
{
"name" : "email",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-email",
"type" : "token",
"documentation" : "A value in an email contact"
}]
},
{
"type" : "PaymentNotice",
"profile" : "http://hl7.org/fhir/StructureDefinition/PaymentNotice",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["PaymentNotice.request",
"PaymentNotice.provider",
"PaymentNotice.response"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/PaymentNotice-identifier",
"type" : "token",
"documentation" : "The business identifier of the notice"
},
{
"name" : "request",
"definition" : "http://hl7.org/fhir/SearchParameter/PaymentNotice-request",
"type" : "reference",
"documentation" : "The Claim"
},
{
"name" : "provider",
"definition" : "http://hl7.org/fhir/SearchParameter/PaymentNotice-provider",
"type" : "reference",
"documentation" : "The reference to the provider"
},
{
"name" : "created",
"definition" : "http://hl7.org/fhir/SearchParameter/PaymentNotice-created",
"type" : "date",
"documentation" : "Creation date fro the notice"
},
{
"name" : "response",
"definition" : "http://hl7.org/fhir/SearchParameter/PaymentNotice-response",
"type" : "reference",
"documentation" : "The ClaimResponse"
},
{
"name" : "payment-status",
"definition" : "http://hl7.org/fhir/SearchParameter/PaymentNotice-payment-status",
"type" : "token",
"documentation" : "The type of payment notice"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/PaymentNotice-status",
"type" : "token",
"documentation" : "The status of the payment notice"
}]
},
{
"type" : "PaymentReconciliation",
"profile" : "http://hl7.org/fhir/StructureDefinition/PaymentReconciliation",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["PaymentReconciliation.request",
"PaymentReconciliation.payment-issuer",
"PaymentReconciliation.requestor"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/PaymentReconciliation-identifier",
"type" : "token",
"documentation" : "The business identifier of the ExplanationOfBenefit"
},
{
"name" : "request",
"definition" : "http://hl7.org/fhir/SearchParameter/PaymentReconciliation-request",
"type" : "reference",
"documentation" : "The reference to the claim"
},
{
"name" : "disposition",
"definition" : "http://hl7.org/fhir/SearchParameter/PaymentReconciliation-disposition",
"type" : "string",
"documentation" : "The contents of the disposition message"
},
{
"name" : "created",
"definition" : "http://hl7.org/fhir/SearchParameter/PaymentReconciliation-created",
"type" : "date",
"documentation" : "The creation date"
},
{
"name" : "payment-issuer",
"definition" : "http://hl7.org/fhir/SearchParameter/PaymentReconciliation-payment-issuer",
"type" : "reference",
"documentation" : "The organization which generated this resource"
},
{
"name" : "outcome",
"definition" : "http://hl7.org/fhir/SearchParameter/PaymentReconciliation-outcome",
"type" : "token",
"documentation" : "The processing outcome"
},
{
"name" : "requestor",
"definition" : "http://hl7.org/fhir/SearchParameter/PaymentReconciliation-requestor",
"type" : "reference",
"documentation" : "The reference to the provider who submitted the claim"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/PaymentReconciliation-status",
"type" : "token",
"documentation" : "The status of the payment reconciliation"
}]
},
{
"type" : "Person",
"profile" : "http://hl7.org/fhir/StructureDefinition/Person",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Person.practitioner",
"Person.link",
"Person.relatedperson",
"Person.patient",
"Person.organization"],
"searchRevInclude" : ["Person.practitioner",
"Person.link",
"Person.relatedperson",
"Person.patient"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Person-identifier",
"type" : "token",
"documentation" : "A person Identifier"
},
{
"name" : "address",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-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" : "birthdate",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-birthdate",
"type" : "date",
"documentation" : "The person's date of birth"
},
{
"name" : "address-state",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-state",
"type" : "string",
"documentation" : "A state specified in an address"
},
{
"name" : "gender",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-gender",
"type" : "token",
"documentation" : "The gender of the person"
},
{
"name" : "practitioner",
"definition" : "http://hl7.org/fhir/SearchParameter/Person-practitioner",
"type" : "reference",
"documentation" : "The Person links to this Practitioner"
},
{
"name" : "link",
"definition" : "http://hl7.org/fhir/SearchParameter/Person-link",
"type" : "reference",
"documentation" : "Any link has this Patient, Person, RelatedPerson or Practitioner reference"
},
{
"name" : "relatedperson",
"definition" : "http://hl7.org/fhir/SearchParameter/Person-relatedperson",
"type" : "reference",
"documentation" : "The Person links to this RelatedPerson"
},
{
"name" : "address-postalcode",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-postalcode",
"type" : "string",
"documentation" : "A postal code specified in an address"
},
{
"name" : "address-country",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-country",
"type" : "string",
"documentation" : "A country specified in an address"
},
{
"name" : "phonetic",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-phonetic",
"type" : "string",
"documentation" : "A portion of name using some kind of phonetic matching algorithm"
},
{
"name" : "phone",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-phone",
"type" : "token",
"documentation" : "A value in a phone contact"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/Person-patient",
"type" : "reference",
"documentation" : "The Person links to this Patient"
},
{
"name" : "organization",
"definition" : "http://hl7.org/fhir/SearchParameter/Person-organization",
"type" : "reference",
"documentation" : "The organization at which this person record is being managed"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/Person-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",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-use",
"type" : "token",
"documentation" : "A use code specified in an address"
},
{
"name" : "telecom",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-telecom",
"type" : "token",
"documentation" : "The value in any kind of contact"
},
{
"name" : "address-city",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-city",
"type" : "string",
"documentation" : "A city specified in an address"
},
{
"name" : "email",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-email",
"type" : "token",
"documentation" : "A value in an email contact"
}]
},
{
"type" : "PlanDefinition",
"profile" : "http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["PlanDefinition.successor",
"PlanDefinition.derived-from",
"PlanDefinition.predecessor",
"PlanDefinition.composed-of",
"PlanDefinition.depends-on",
"PlanDefinition.definition"],
"searchRevInclude" : ["CarePlan.instantiates-canonical",
"Communication.instantiates-canonical",
"DeviceRequest.instantiates-canonical",
"FamilyMemberHistory.instantiates-canonical",
"Flag.subject",
"Flag.patient",
"MessageDefinition.parent",
"NutritionOrder.instantiates-canonical",
"PlanDefinition.definition",
"Procedure.instantiates-canonical",
"ResearchStudy.protocol",
"ServiceRequest.instantiates-canonical"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-date",
"type" : "date",
"documentation" : "The plan definition publication date"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-identifier",
"type" : "token",
"documentation" : "External identifier for the plan definition"
},
{
"name" : "successor",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-successor",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the plan definition"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the plan definition"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-description",
"type" : "string",
"documentation" : "The description of the plan definition"
},
{
"name" : "derived-from",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-derived-from",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the plan definition"
},
{
"name" : "predecessor",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-predecessor",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-title",
"type" : "string",
"documentation" : "The human-friendly name of the plan definition"
},
{
"name" : "composed-of",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-composed-of",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-type",
"type" : "token",
"documentation" : "The type of artifact the plan (e.g. order-set, eca-rule, protocol)"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-version",
"type" : "token",
"documentation" : "The business version of the plan definition"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-url",
"type" : "uri",
"documentation" : "The uri that identifies the plan definition"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the plan definition"
},
{
"name" : "effective",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-effective",
"type" : "date",
"documentation" : "The time during which the plan definition is intended to be in use"
},
{
"name" : "depends-on",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-depends-on",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-name",
"type" : "string",
"documentation" : "Computationally friendly name of the plan definition"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-context",
"type" : "token",
"documentation" : "A use context assigned to the plan definition"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the plan definition"
},
{
"name" : "topic",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-topic",
"type" : "token",
"documentation" : "Topics associated with the module"
},
{
"name" : "definition",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-definition",
"type" : "reference",
"documentation" : "Activity or plan definitions used by plan definition"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the plan definition"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-status",
"type" : "token",
"documentation" : "The current status of the plan definition"
}]
},
{
"type" : "Practitioner",
"profile" : "http://hl7.org/fhir/StructureDefinition/Practitioner",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchRevInclude" : ["Account.subject",
"Account.patient",
"AdverseEvent.recorder",
"AdverseEvent.subject",
"AllergyIntolerance.recorder",
"AllergyIntolerance.asserter",
"Appointment.practitioner",
"Appointment.actor",
"Appointment.patient",
"Appointment.location",
"AppointmentResponse.actor",
"AppointmentResponse.practitioner",
"AppointmentResponse.patient",
"AppointmentResponse.location",
"AuditEvent.agent",
"AuditEvent.source",
"AuditEvent.patient",
"Basic.author",
"CarePlan.performer",
"CareTeam.participant",
"ChargeItem.enterer",
"ChargeItem.performer-actor",
"Claim.care-team",
"Claim.payee",
"Claim.provider",
"Claim.enterer",
"ClaimResponse.requestor",
"ClinicalImpression.assessor",
"Communication.sender",
"Communication.recipient",
"CommunicationRequest.requester",
"CommunicationRequest.sender",
"CommunicationRequest.recipient",
"Composition.author",
"Composition.attester",
"Condition.asserter",
"Consent.actor",
"Consent.consentor",
"Contract.signer",
"CoverageEligibilityRequest.provider",
"CoverageEligibilityRequest.enterer",
"CoverageEligibilityResponse.requestor",
"DetectedIssue.author",
"DeviceRequest.requester",
"DeviceRequest.performer",
"DiagnosticReport.performer",
"DiagnosticReport.results-interpreter",
"DocumentManifest.subject",
"DocumentManifest.author",
"DocumentManifest.patient",
"DocumentManifest.recipient",
"DocumentReference.subject",
"DocumentReference.patient",
"DocumentReference.authenticator",
"DocumentReference.author",
"Encounter.practitioner",
"Encounter.participant",
"EpisodeOfCare.care-manager",
"ExplanationOfBenefit.care-team",
"ExplanationOfBenefit.payee",
"ExplanationOfBenefit.provider",
"ExplanationOfBenefit.enterer",
"Flag.subject",
"Flag.patient",
"Flag.author",
"Group.managing-entity",
"Group.member",
"ImagingStudy.performer",
"ImagingStudy.interpreter",
"ImagingStudy.referrer",
"Immunization.performer",
"Invoice.participant",
"Linkage.author",
"List.source",
"MeasureReport.patient",
"MeasureReport.subject",
"MeasureReport.reporter",
"Media.subject",
"Media.operator",
"Media.patient",
"MedicationAdministration.performer",
"MedicationDispense.performer",
"MedicationDispense.receiver",
"MedicationDispense.responsibleparty",
"MedicationRequest.requester",
"MedicationRequest.intended-performer",
"MedicationStatement.source",
"MessageHeader.receiver",
"MessageHeader.author",
"MessageHeader.sender",
"MessageHeader.responsible",
"MessageHeader.enterer",
"NutritionOrder.provider",
"Observation.performer",
"Patient.general-practitioner",
"PaymentNotice.provider",
"PaymentReconciliation.requestor",
"Person.practitioner",
"Person.link",
"Person.relatedperson",
"Person.patient",
"PractitionerRole.practitioner",
"Procedure.performer",
"Provenance.agent",
"QuestionnaireResponse.author",
"QuestionnaireResponse.source",
"RequestGroup.author",
"RequestGroup.participant",
"ResearchStudy.principalinvestigator",
"RiskAssessment.performer",
"Schedule.actor",
"ServiceRequest.requester",
"ServiceRequest.performer",
"Specimen.collector",
"SupplyDelivery.receiver",
"SupplyDelivery.supplier",
"SupplyRequest.requester",
"Task.owner",
"Task.requester",
"VisionPrescription.prescriber"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Practitioner-identifier",
"type" : "token",
"documentation" : "A practitioner's Identifier"
},
{
"name" : "given",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-given",
"type" : "string",
"documentation" : "A portion of the given name"
},
{
"name" : "address",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-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",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-state",
"type" : "string",
"documentation" : "A state specified in an address"
},
{
"name" : "gender",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-gender",
"type" : "token",
"documentation" : "Gender of the practitioner"
},
{
"name" : "active",
"definition" : "http://hl7.org/fhir/SearchParameter/Practitioner-active",
"type" : "token",
"documentation" : "Whether the practitioner record is active"
},
{
"name" : "address-postalcode",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-postalcode",
"type" : "string",
"documentation" : "A postalCode specified in an address"
},
{
"name" : "address-country",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-country",
"type" : "string",
"documentation" : "A country specified in an address"
},
{
"name" : "phonetic",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-phonetic",
"type" : "string",
"documentation" : "A portion of either family or given name using some kind of phonetic matching algorithm"
},
{
"name" : "phone",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-phone",
"type" : "token",
"documentation" : "A value in a phone contact"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/Practitioner-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",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-use",
"type" : "token",
"documentation" : "A use code specified in an address"
},
{
"name" : "telecom",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-telecom",
"type" : "token",
"documentation" : "The value in any kind of contact"
},
{
"name" : "family",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-family",
"type" : "string",
"documentation" : "A portion of the family name"
},
{
"name" : "address-city",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-city",
"type" : "string",
"documentation" : "A city specified in an address"
},
{
"name" : "communication",
"definition" : "http://hl7.org/fhir/SearchParameter/Practitioner-communication",
"type" : "token",
"documentation" : "One of the languages that the practitioner can communicate with"
},
{
"name" : "email",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-email",
"type" : "token",
"documentation" : "A value in an email contact"
}]
},
{
"type" : "PractitionerRole",
"profile" : "http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["PractitionerRole.practitioner",
"PractitionerRole.endpoint",
"PractitionerRole.service",
"PractitionerRole.organization",
"PractitionerRole.location"],
"searchRevInclude" : ["Account.subject",
"Account.patient",
"AdverseEvent.recorder",
"AllergyIntolerance.recorder",
"AllergyIntolerance.asserter",
"Appointment.practitioner",
"Appointment.actor",
"Appointment.patient",
"Appointment.location",
"AppointmentResponse.actor",
"AppointmentResponse.practitioner",
"AppointmentResponse.patient",
"AppointmentResponse.location",
"AuditEvent.agent",
"AuditEvent.source",
"AuditEvent.patient",
"Basic.author",
"CarePlan.performer",
"CareTeam.participant",
"ChargeItem.enterer",
"ChargeItem.performer-actor",
"Claim.care-team",
"Claim.payee",
"Claim.provider",
"Claim.enterer",
"ClaimResponse.requestor",
"ClinicalImpression.assessor",
"Communication.sender",
"Communication.recipient",
"CommunicationRequest.requester",
"CommunicationRequest.sender",
"CommunicationRequest.recipient",
"Composition.author",
"Composition.attester",
"Condition.asserter",
"Consent.actor",
"Consent.consentor",
"Contract.signer",
"CoverageEligibilityRequest.provider",
"CoverageEligibilityRequest.enterer",
"CoverageEligibilityResponse.requestor",
"DetectedIssue.author",
"DeviceRequest.requester",
"DeviceRequest.performer",
"DiagnosticReport.performer",
"DiagnosticReport.results-interpreter",
"DocumentManifest.author",
"DocumentManifest.recipient",
"DocumentReference.authenticator",
"DocumentReference.author",
"Encounter.practitioner",
"Encounter.participant",
"EpisodeOfCare.care-manager",
"ExplanationOfBenefit.care-team",
"ExplanationOfBenefit.payee",
"ExplanationOfBenefit.provider",
"ExplanationOfBenefit.enterer",
"Flag.author",
"Group.managing-entity",
"Group.member",
"ImagingStudy.performer",
"ImagingStudy.interpreter",
"ImagingStudy.referrer",
"Immunization.performer",
"Invoice.participant",
"Linkage.author",
"List.source",
"MeasureReport.patient",
"MeasureReport.subject",
"MeasureReport.reporter",
"Media.subject",
"Media.operator",
"Media.patient",
"MedicationAdministration.performer",
"MedicationDispense.performer",
"MedicationDispense.responsibleparty",
"MedicationRequest.requester",
"MedicationRequest.intended-performer",
"MedicationStatement.source",
"MessageHeader.receiver",
"MessageHeader.author",
"MessageHeader.sender",
"MessageHeader.responsible",
"MessageHeader.enterer",
"NutritionOrder.provider",
"Observation.performer",
"Patient.general-practitioner",
"PaymentNotice.provider",
"PaymentReconciliation.requestor",
"Procedure.performer",
"Provenance.agent",
"QuestionnaireResponse.author",
"QuestionnaireResponse.source",
"RequestGroup.author",
"RequestGroup.participant",
"ResearchStudy.principalinvestigator",
"RiskAssessment.performer",
"Schedule.actor",
"ServiceRequest.requester",
"ServiceRequest.performer",
"Specimen.collector",
"SupplyDelivery.receiver",
"SupplyDelivery.supplier",
"SupplyRequest.requester",
"Task.owner",
"Task.requester",
"VisionPrescription.prescriber"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/PractitionerRole-date",
"type" : "date",
"documentation" : "The period during which the practitioner is authorized to perform in these role(s)"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/PractitionerRole-identifier",
"type" : "token",
"documentation" : "A practitioner's Identifier"
},
{
"name" : "specialty",
"definition" : "http://hl7.org/fhir/SearchParameter/PractitionerRole-specialty",
"type" : "token",
"documentation" : "The practitioner has this specialty at an organization"
},
{
"name" : "role",
"definition" : "http://hl7.org/fhir/SearchParameter/PractitionerRole-role",
"type" : "token",
"documentation" : "The practitioner can perform this role at for the organization"
},
{
"name" : "practitioner",
"definition" : "http://hl7.org/fhir/SearchParameter/PractitionerRole-practitioner",
"type" : "reference",
"documentation" : "Practitioner that is able to provide the defined services for the organization"
},
{
"name" : "active",
"definition" : "http://hl7.org/fhir/SearchParameter/PractitionerRole-active",
"type" : "token",
"documentation" : "Whether this practitioner role record is in active use"
},
{
"name" : "endpoint",
"definition" : "http://hl7.org/fhir/SearchParameter/PractitionerRole-endpoint",
"type" : "reference",
"documentation" : "Technical endpoints providing access to services operated for the practitioner with this role"
},
{
"name" : "phone",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-phone",
"type" : "token",
"documentation" : "A value in a phone contact"
},
{
"name" : "service",
"definition" : "http://hl7.org/fhir/SearchParameter/PractitionerRole-service",
"type" : "reference",
"documentation" : "The list of healthcare services that this worker provides for this role's Organization/Location(s)"
},
{
"name" : "organization",
"definition" : "http://hl7.org/fhir/SearchParameter/PractitionerRole-organization",
"type" : "reference",
"documentation" : "The identity of the organization the practitioner represents / acts on behalf of"
},
{
"name" : "telecom",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-telecom",
"type" : "token",
"documentation" : "The value in any kind of contact"
},
{
"name" : "location",
"definition" : "http://hl7.org/fhir/SearchParameter/PractitionerRole-location",
"type" : "reference",
"documentation" : "One of the locations at which this practitioner provides care"
},
{
"name" : "email",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-email",
"type" : "token",
"documentation" : "A value in an email contact"
}]
},
{
"type" : "Procedure",
"profile" : "http://hl7.org/fhir/StructureDefinition/Procedure",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Procedure.performer",
"Procedure.subject",
"Procedure.instantiates-canonical",
"Procedure.part-of",
"Procedure.encounter",
"Procedure.based-on",
"Procedure.patient",
"Procedure.reason-reference",
"Procedure.location"],
"searchRevInclude" : ["AdverseEvent.substance",
"Appointment.reason-reference",
"ChargeItem.service",
"Encounter.diagnosis",
"Encounter.reason-reference",
"Flag.subject",
"Flag.patient",
"MedicationStatement.part-of",
"Observation.part-of",
"Procedure.part-of",
"Procedure.reason-reference",
"QuestionnaireResponse.part-of"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "When the procedure was performed"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "A unique identifier for a procedure"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "A code to identify a procedure"
},
{
"name" : "performer",
"definition" : "http://hl7.org/fhir/SearchParameter/Procedure-performer",
"type" : "reference",
"documentation" : "The reference to the practitioner"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/Procedure-subject",
"type" : "reference",
"documentation" : "Search by subject"
},
{
"name" : "instantiates-canonical",
"definition" : "http://hl7.org/fhir/SearchParameter/Procedure-instantiates-canonical",
"type" : "reference",
"documentation" : "Instantiates FHIR protocol or definition"
},
{
"name" : "part-of",
"definition" : "http://hl7.org/fhir/SearchParameter/Procedure-part-of",
"type" : "reference",
"documentation" : "Part of referenced event"
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type" : "reference",
"documentation" : "Encounter created as part of"
},
{
"name" : "reason-code",
"definition" : "http://hl7.org/fhir/SearchParameter/Procedure-reason-code",
"type" : "token",
"documentation" : "Coded reason procedure performed"
},
{
"name" : "based-on",
"definition" : "http://hl7.org/fhir/SearchParameter/Procedure-based-on",
"type" : "reference",
"documentation" : "A request for this procedure"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Search by subject - a patient"
},
{
"name" : "reason-reference",
"definition" : "http://hl7.org/fhir/SearchParameter/Procedure-reason-reference",
"type" : "reference",
"documentation" : "The justification that the procedure was performed"
},
{
"name" : "location",
"definition" : "http://hl7.org/fhir/SearchParameter/Procedure-location",
"type" : "reference",
"documentation" : "Where the procedure happened"
},
{
"name" : "instantiates-uri",
"definition" : "http://hl7.org/fhir/SearchParameter/Procedure-instantiates-uri",
"type" : "uri",
"documentation" : "Instantiates external protocol or definition"
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Procedure-category",
"type" : "token",
"documentation" : "Classification of the procedure"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Procedure-status",
"type" : "token",
"documentation" : "preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error | unknown"
}]
},
{
"type" : "Provenance",
"profile" : "http://hl7.org/fhir/StructureDefinition/Provenance",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Provenance.agent",
"Provenance.patient",
"Provenance.location",
"Provenance.entity",
"Provenance.target"],
"searchParam" : [{
"name" : "agent-type",
"definition" : "http://hl7.org/fhir/SearchParameter/Provenance-agent-type",
"type" : "token",
"documentation" : "How the agent participated"
},
{
"name" : "agent",
"definition" : "http://hl7.org/fhir/SearchParameter/Provenance-agent",
"type" : "reference",
"documentation" : "Who participated"
},
{
"name" : "signature-type",
"definition" : "http://hl7.org/fhir/SearchParameter/Provenance-signature-type",
"type" : "token",
"documentation" : "Indication of the reason the entity signed the object(s)"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/Provenance-patient",
"type" : "reference",
"documentation" : "Target Reference(s) (usually version specific)"
},
{
"name" : "location",
"definition" : "http://hl7.org/fhir/SearchParameter/Provenance-location",
"type" : "reference",
"documentation" : "Where the activity occurred, if relevant"
},
{
"name" : "recorded",
"definition" : "http://hl7.org/fhir/SearchParameter/Provenance-recorded",
"type" : "date",
"documentation" : "When the activity was recorded / updated"
},
{
"name" : "agent-role",
"definition" : "http://hl7.org/fhir/SearchParameter/Provenance-agent-role",
"type" : "token",
"documentation" : "What the agents role was"
},
{
"name" : "when",
"definition" : "http://hl7.org/fhir/SearchParameter/Provenance-when",
"type" : "date",
"documentation" : "When the activity occurred"
},
{
"name" : "entity",
"definition" : "http://hl7.org/fhir/SearchParameter/Provenance-entity",
"type" : "reference",
"documentation" : "Identity of entity"
},
{
"name" : "target",
"definition" : "http://hl7.org/fhir/SearchParameter/Provenance-target",
"type" : "reference",
"documentation" : "Target Reference(s) (usually version specific)"
}]
},
{
"type" : "Questionnaire",
"profile" : "http://hl7.org/fhir/StructureDefinition/Questionnaire",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchRevInclude" : ["CarePlan.instantiates-canonical",
"Communication.instantiates-canonical",
"FamilyMemberHistory.instantiates-canonical",
"PlanDefinition.definition",
"Procedure.instantiates-canonical",
"QuestionnaireResponse.questionnaire"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-date",
"type" : "date",
"documentation" : "The questionnaire publication date"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-identifier",
"type" : "token",
"documentation" : "External identifier for the questionnaire"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-code",
"type" : "token",
"documentation" : "A code that corresponds to one of its items in the questionnaire"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the questionnaire"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the questionnaire"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-description",
"type" : "string",
"documentation" : "The description of the questionnaire"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the questionnaire"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-title",
"type" : "string",
"documentation" : "The human-friendly name of the questionnaire"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-version",
"type" : "token",
"documentation" : "The business version of the questionnaire"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-url",
"type" : "uri",
"documentation" : "The uri that identifies the questionnaire"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the questionnaire"
},
{
"name" : "effective",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-effective",
"type" : "date",
"documentation" : "The time during which the questionnaire is intended to be in use"
},
{
"name" : "subject-type",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-subject-type",
"type" : "token",
"documentation" : "Resource that can be subject of QuestionnaireResponse"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-name",
"type" : "string",
"documentation" : "Computationally friendly name of the questionnaire"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-context",
"type" : "token",
"documentation" : "A use context assigned to the questionnaire"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the questionnaire"
},
{
"name" : "definition",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-definition",
"type" : "uri",
"documentation" : "ElementDefinition - details for the item"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the questionnaire"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-status",
"type" : "token",
"documentation" : "The current status of the questionnaire"
}]
},
{
"type" : "QuestionnaireResponse",
"profile" : "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["QuestionnaireResponse.questionnaire",
"QuestionnaireResponse.based-on",
"QuestionnaireResponse.subject",
"QuestionnaireResponse.author",
"QuestionnaireResponse.patient",
"QuestionnaireResponse.part-of",
"QuestionnaireResponse.encounter",
"QuestionnaireResponse.source"],
"searchRevInclude" : ["ClinicalImpression.investigation",
"Consent.source-reference",
"Observation.derived-from",
"Observation.has-member"],
"searchParam" : [{
"name" : "authored",
"definition" : "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-authored",
"type" : "date",
"documentation" : "When the questionnaire response was last changed"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-identifier",
"type" : "token",
"documentation" : "The unique identifier for the questionnaire response"
},
{
"name" : "questionnaire",
"definition" : "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-questionnaire",
"type" : "reference",
"documentation" : "The questionnaire the answers are provided for"
},
{
"name" : "based-on",
"definition" : "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-based-on",
"type" : "reference",
"documentation" : "Plan/proposal/order fulfilled by this questionnaire response"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-subject",
"type" : "reference",
"documentation" : "The subject of the questionnaire response"
},
{
"name" : "author",
"definition" : "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-author",
"type" : "reference",
"documentation" : "The author of the questionnaire response"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-patient",
"type" : "reference",
"documentation" : "The patient that is the subject of the questionnaire response"
},
{
"name" : "part-of",
"definition" : "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-part-of",
"type" : "reference",
"documentation" : "Procedure or observation this questionnaire response was performed as a part of"
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-encounter",
"type" : "reference",
"documentation" : "Encounter associated with the questionnaire response"
},
{
"name" : "source",
"definition" : "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-source",
"type" : "reference",
"documentation" : "The individual providing the information reflected in the questionnaire respose"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-status",
"type" : "token",
"documentation" : "The status of the questionnaire response"
}]
},
{
"type" : "RelatedPerson",
"profile" : "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["RelatedPerson.patient"],
"searchRevInclude" : ["AdverseEvent.recorder",
"AdverseEvent.subject",
"AllergyIntolerance.recorder",
"AllergyIntolerance.asserter",
"Appointment.practitioner",
"Appointment.actor",
"Appointment.patient",
"Appointment.location",
"AppointmentResponse.actor",
"AppointmentResponse.practitioner",
"AppointmentResponse.patient",
"AppointmentResponse.location",
"AuditEvent.agent",
"AuditEvent.source",
"AuditEvent.patient",
"Basic.author",
"CarePlan.performer",
"CareTeam.participant",
"ChargeItem.enterer",
"ChargeItem.performer-actor",
"Claim.payee",
"Communication.sender",
"Communication.recipient",
"CommunicationRequest.requester",
"CommunicationRequest.sender",
"CommunicationRequest.recipient",
"Composition.author",
"Composition.attester",
"Condition.asserter",
"Consent.actor",
"Consent.consentor",
"Contract.signer",
"Coverage.payor",
"Coverage.subscriber",
"Coverage.policy-holder",
"DeviceRequest.performer",
"DocumentManifest.author",
"DocumentManifest.recipient",
"DocumentReference.author",
"Encounter.practitioner",
"Encounter.participant",
"ExplanationOfBenefit.payee",
"Group.managing-entity",
"ImagingStudy.performer",
"Invoice.participant",
"Invoice.recipient",
"MeasureReport.patient",
"MeasureReport.subject",
"Media.operator",
"MedicationAdministration.performer",
"MedicationDispense.performer",
"MedicationRequest.requester",
"MedicationRequest.intended-performer",
"MedicationStatement.source",
"Observation.performer",
"Patient.link",
"Person.practitioner",
"Person.link",
"Person.relatedperson",
"Person.patient",
"Procedure.performer",
"Provenance.agent",
"QuestionnaireResponse.author",
"QuestionnaireResponse.source",
"RequestGroup.participant",
"Schedule.actor",
"ServiceRequest.requester",
"ServiceRequest.performer",
"SupplyRequest.requester",
"Task.owner",
"Task.requester"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/RelatedPerson-identifier",
"type" : "token",
"documentation" : "An Identifier of the RelatedPerson"
},
{
"name" : "address",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-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" : "birthdate",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-birthdate",
"type" : "date",
"documentation" : "The Related Person's date of birth"
},
{
"name" : "address-state",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-state",
"type" : "string",
"documentation" : "A state specified in an address"
},
{
"name" : "gender",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-gender",
"type" : "token",
"documentation" : "Gender of the related person"
},
{
"name" : "active",
"definition" : "http://hl7.org/fhir/SearchParameter/RelatedPerson-active",
"type" : "token",
"documentation" : "Indicates if the related person record is active"
},
{
"name" : "address-postalcode",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-postalcode",
"type" : "string",
"documentation" : "A postal code specified in an address"
},
{
"name" : "address-country",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-country",
"type" : "string",
"documentation" : "A country specified in an address"
},
{
"name" : "phonetic",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-phonetic",
"type" : "string",
"documentation" : "A portion of name using some kind of phonetic matching algorithm"
},
{
"name" : "phone",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-phone",
"type" : "token",
"documentation" : "A value in a phone contact"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/RelatedPerson-patient",
"type" : "reference",
"documentation" : "The patient this related person is related to"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/RelatedPerson-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",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-use",
"type" : "token",
"documentation" : "A use code specified in an address"
},
{
"name" : "telecom",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-telecom",
"type" : "token",
"documentation" : "The value in any kind of contact"
},
{
"name" : "address-city",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-city",
"type" : "string",
"documentation" : "A city specified in an address"
},
{
"name" : "relationship",
"definition" : "http://hl7.org/fhir/SearchParameter/RelatedPerson-relationship",
"type" : "token",
"documentation" : "The relationship between the patient and the relatedperson"
},
{
"name" : "email",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-email",
"type" : "token",
"documentation" : "A value in an email contact"
}]
},
{
"type" : "RequestGroup",
"profile" : "http://hl7.org/fhir/StructureDefinition/RequestGroup",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["RequestGroup.subject",
"RequestGroup.author",
"RequestGroup.instantiates-canonical",
"RequestGroup.encounter",
"RequestGroup.participant",
"RequestGroup.patient"],
"searchRevInclude" : ["CarePlan.activity-reference"],
"searchParam" : [{
"name" : "authored",
"definition" : "http://hl7.org/fhir/SearchParameter/RequestGroup-authored",
"type" : "date",
"documentation" : "The date the request group was authored"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/RequestGroup-identifier",
"type" : "token",
"documentation" : "External identifiers for the request group"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/RequestGroup-code",
"type" : "token",
"documentation" : "The code of the request group"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/RequestGroup-subject",
"type" : "reference",
"documentation" : "The subject that the request group is about"
},
{
"name" : "author",
"definition" : "http://hl7.org/fhir/SearchParameter/RequestGroup-author",
"type" : "reference",
"documentation" : "The author of the request group"
},
{
"name" : "instantiates-canonical",
"definition" : "http://hl7.org/fhir/SearchParameter/RequestGroup-instantiates-canonical",
"type" : "reference",
"documentation" : "The FHIR-based definition from which the request group is realized"
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/RequestGroup-encounter",
"type" : "reference",
"documentation" : "The encounter the request group applies to"
},
{
"name" : "priority",
"definition" : "http://hl7.org/fhir/SearchParameter/RequestGroup-priority",
"type" : "token",
"documentation" : "The priority of the request group"
},
{
"name" : "intent",
"definition" : "http://hl7.org/fhir/SearchParameter/RequestGroup-intent",
"type" : "token",
"documentation" : "The intent of the request group"
},
{
"name" : "participant",
"definition" : "http://hl7.org/fhir/SearchParameter/RequestGroup-participant",
"type" : "reference",
"documentation" : "The participant in the requests in the group"
},
{
"name" : "group-identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/RequestGroup-group-identifier",
"type" : "token",
"documentation" : "The group identifier for the request group"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/RequestGroup-patient",
"type" : "reference",
"documentation" : "The identity of a patient to search for request groups"
},
{
"name" : "instantiates-uri",
"definition" : "http://hl7.org/fhir/SearchParameter/RequestGroup-instantiates-uri",
"type" : "uri",
"documentation" : "The external definition from which the request group is realized"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/RequestGroup-status",
"type" : "token",
"documentation" : "The status of the request group"
}]
},
{
"type" : "ResearchDefinition",
"profile" : "http://hl7.org/fhir/StructureDefinition/ResearchDefinition",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["ResearchDefinition.successor",
"ResearchDefinition.derived-from",
"ResearchDefinition.predecessor",
"ResearchDefinition.composed-of",
"ResearchDefinition.depends-on"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchDefinition-date",
"type" : "date",
"documentation" : "The research definition publication date"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchDefinition-identifier",
"type" : "token",
"documentation" : "External identifier for the research definition"
},
{
"name" : "successor",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchDefinition-successor",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchDefinition-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the research definition"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchDefinition-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the research definition"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchDefinition-description",
"type" : "string",
"documentation" : "The description of the research definition"
},
{
"name" : "derived-from",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchDefinition-derived-from",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchDefinition-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the research definition"
},
{
"name" : "predecessor",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchDefinition-predecessor",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchDefinition-title",
"type" : "string",
"documentation" : "The human-friendly name of the research definition"
},
{
"name" : "composed-of",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchDefinition-composed-of",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchDefinition-version",
"type" : "token",
"documentation" : "The business version of the research definition"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchDefinition-url",
"type" : "uri",
"documentation" : "The uri that identifies the research definition"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchDefinition-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the research definition"
},
{
"name" : "effective",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchDefinition-effective",
"type" : "date",
"documentation" : "The time during which the research definition is intended to be in use"
},
{
"name" : "depends-on",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchDefinition-depends-on",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchDefinition-name",
"type" : "string",
"documentation" : "Computationally friendly name of the research definition"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchDefinition-context",
"type" : "token",
"documentation" : "A use context assigned to the research definition"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchDefinition-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the research definition"
},
{
"name" : "topic",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchDefinition-topic",
"type" : "token",
"documentation" : "Topics associated with the ResearchDefinition"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchDefinition-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the research definition"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchDefinition-status",
"type" : "token",
"documentation" : "The current status of the research definition"
}]
},
{
"type" : "ResearchElementDefinition",
"profile" : "http://hl7.org/fhir/StructureDefinition/ResearchElementDefinition",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["ResearchElementDefinition.successor",
"ResearchElementDefinition.derived-from",
"ResearchElementDefinition.predecessor",
"ResearchElementDefinition.composed-of",
"ResearchElementDefinition.depends-on"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchElementDefinition-date",
"type" : "date",
"documentation" : "The research element definition publication date"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchElementDefinition-identifier",
"type" : "token",
"documentation" : "External identifier for the research element definition"
},
{
"name" : "successor",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchElementDefinition-successor",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchElementDefinition-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the research element definition"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchElementDefinition-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the research element definition"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchElementDefinition-description",
"type" : "string",
"documentation" : "The description of the research element definition"
},
{
"name" : "derived-from",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchElementDefinition-derived-from",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchElementDefinition-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the research element definition"
},
{
"name" : "predecessor",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchElementDefinition-predecessor",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchElementDefinition-title",
"type" : "string",
"documentation" : "The human-friendly name of the research element definition"
},
{
"name" : "composed-of",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchElementDefinition-composed-of",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchElementDefinition-version",
"type" : "token",
"documentation" : "The business version of the research element definition"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchElementDefinition-url",
"type" : "uri",
"documentation" : "The uri that identifies the research element definition"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchElementDefinition-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the research element definition"
},
{
"name" : "effective",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchElementDefinition-effective",
"type" : "date",
"documentation" : "The time during which the research element definition is intended to be in use"
},
{
"name" : "depends-on",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchElementDefinition-depends-on",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchElementDefinition-name",
"type" : "string",
"documentation" : "Computationally friendly name of the research element definition"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchElementDefinition-context",
"type" : "token",
"documentation" : "A use context assigned to the research element definition"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchElementDefinition-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the research element definition"
},
{
"name" : "topic",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchElementDefinition-topic",
"type" : "token",
"documentation" : "Topics associated with the ResearchElementDefinition"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchElementDefinition-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the research element definition"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchElementDefinition-status",
"type" : "token",
"documentation" : "The current status of the research element definition"
}]
},
{
"type" : "ResearchStudy",
"profile" : "http://hl7.org/fhir/StructureDefinition/ResearchStudy",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["ResearchStudy.partof",
"ResearchStudy.sponsor",
"ResearchStudy.principalinvestigator",
"ResearchStudy.protocol",
"ResearchStudy.site"],
"searchRevInclude" : ["AdverseEvent.study",
"ResearchStudy.partof",
"ResearchSubject.study"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchStudy-date",
"type" : "date",
"documentation" : "When the study began and ended"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchStudy-identifier",
"type" : "token",
"documentation" : "Business Identifier for study"
},
{
"name" : "partof",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchStudy-partof",
"type" : "reference",
"documentation" : "Part of larger study"
},
{
"name" : "sponsor",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchStudy-sponsor",
"type" : "reference",
"documentation" : "Organization that initiates and is legally responsible for the study"
},
{
"name" : "focus",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchStudy-focus",
"type" : "token",
"documentation" : "Drugs, devices, etc. under study"
},
{
"name" : "principalinvestigator",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchStudy-principalinvestigator",
"type" : "reference",
"documentation" : "Researcher who oversees multiple aspects of the study"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchStudy-title",
"type" : "string",
"documentation" : "Name for this study"
},
{
"name" : "protocol",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchStudy-protocol",
"type" : "reference",
"documentation" : "Steps followed in executing study"
},
{
"name" : "site",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchStudy-site",
"type" : "reference",
"documentation" : "Facility where study activities are conducted"
},
{
"name" : "location",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchStudy-location",
"type" : "token",
"documentation" : "Geographic region(s) for study"
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchStudy-category",
"type" : "token",
"documentation" : "Classifications for the study"
},
{
"name" : "keyword",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchStudy-keyword",
"type" : "token",
"documentation" : "Used to search for the study"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchStudy-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"
}]
},
{
"type" : "ResearchSubject",
"profile" : "http://hl7.org/fhir/StructureDefinition/ResearchSubject",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["ResearchSubject.study",
"ResearchSubject.individual",
"ResearchSubject.patient"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchSubject-date",
"type" : "date",
"documentation" : "Start and end of participation"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchSubject-identifier",
"type" : "token",
"documentation" : "Business Identifier for research subject in a study"
},
{
"name" : "study",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchSubject-study",
"type" : "reference",
"documentation" : "Study subject is part of"
},
{
"name" : "individual",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchSubject-individual",
"type" : "reference",
"documentation" : "Who is part of study"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchSubject-patient",
"type" : "reference",
"documentation" : "Who is part of study"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/ResearchSubject-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"
}]
},
{
"type" : "RiskAssessment",
"profile" : "http://hl7.org/fhir/StructureDefinition/RiskAssessment",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["RiskAssessment.condition",
"RiskAssessment.performer",
"RiskAssessment.subject",
"RiskAssessment.patient",
"RiskAssessment.encounter"],
"searchRevInclude" : ["ClinicalImpression.investigation"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "When was assessment made?"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "Unique identifier for the assessment"
},
{
"name" : "condition",
"definition" : "http://hl7.org/fhir/SearchParameter/RiskAssessment-condition",
"type" : "reference",
"documentation" : "Condition assessed"
},
{
"name" : "performer",
"definition" : "http://hl7.org/fhir/SearchParameter/RiskAssessment-performer",
"type" : "reference",
"documentation" : "Who did assessment?"
},
{
"name" : "method",
"definition" : "http://hl7.org/fhir/SearchParameter/RiskAssessment-method",
"type" : "token",
"documentation" : "Evaluation mechanism"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/RiskAssessment-subject",
"type" : "reference",
"documentation" : "Who/what does assessment apply to?"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Who/what does assessment apply to?"
},
{
"name" : "probability",
"definition" : "http://hl7.org/fhir/SearchParameter/RiskAssessment-probability",
"type" : "number",
"documentation" : "Likelihood of specified outcome"
},
{
"name" : "risk",
"definition" : "http://hl7.org/fhir/SearchParameter/RiskAssessment-risk",
"type" : "token",
"documentation" : "Likelihood of specified outcome as a qualitative value"
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type" : "reference",
"documentation" : "Where was assessment performed?"
}]
},
{
"type" : "RiskEvidenceSynthesis",
"profile" : "http://hl7.org/fhir/StructureDefinition/RiskEvidenceSynthesis",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/RiskEvidenceSynthesis-date",
"type" : "date",
"documentation" : "The risk evidence synthesis publication date"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/RiskEvidenceSynthesis-identifier",
"type" : "token",
"documentation" : "External identifier for the risk evidence synthesis"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/RiskEvidenceSynthesis-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the risk evidence synthesis"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/RiskEvidenceSynthesis-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the risk evidence synthesis"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/RiskEvidenceSynthesis-description",
"type" : "string",
"documentation" : "The description of the risk evidence synthesis"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/RiskEvidenceSynthesis-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the risk evidence synthesis"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/RiskEvidenceSynthesis-title",
"type" : "string",
"documentation" : "The human-friendly name of the risk evidence synthesis"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/RiskEvidenceSynthesis-version",
"type" : "token",
"documentation" : "The business version of the risk evidence synthesis"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/RiskEvidenceSynthesis-url",
"type" : "uri",
"documentation" : "The uri that identifies the risk evidence synthesis"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/RiskEvidenceSynthesis-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the risk evidence synthesis"
},
{
"name" : "effective",
"definition" : "http://hl7.org/fhir/SearchParameter/RiskEvidenceSynthesis-effective",
"type" : "date",
"documentation" : "The time during which the risk evidence synthesis is intended to be in use"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/RiskEvidenceSynthesis-name",
"type" : "string",
"documentation" : "Computationally friendly name of the risk evidence synthesis"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/RiskEvidenceSynthesis-context",
"type" : "token",
"documentation" : "A use context assigned to the risk evidence synthesis"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/RiskEvidenceSynthesis-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the risk evidence synthesis"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/RiskEvidenceSynthesis-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the risk evidence synthesis"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/RiskEvidenceSynthesis-status",
"type" : "token",
"documentation" : "The current status of the risk evidence synthesis"
}]
},
{
"type" : "Schedule",
"profile" : "http://hl7.org/fhir/StructureDefinition/Schedule",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Schedule.actor"],
"searchRevInclude" : ["Slot.schedule"],
"searchParam" : [{
"name" : "actor",
"definition" : "http://hl7.org/fhir/SearchParameter/Schedule-actor",
"type" : "reference",
"documentation" : "The individual(HealthcareService, Practitioner, Location, ...) to find a Schedule for"
},
{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/Schedule-date",
"type" : "date",
"documentation" : "Search for Schedule resources that have a period that contains this date specified"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Schedule-identifier",
"type" : "token",
"documentation" : "A Schedule Identifier"
},
{
"name" : "specialty",
"definition" : "http://hl7.org/fhir/SearchParameter/Schedule-specialty",
"type" : "token",
"documentation" : "Type of specialty needed"
},
{
"name" : "service-category",
"definition" : "http://hl7.org/fhir/SearchParameter/Schedule-service-category",
"type" : "token",
"documentation" : "High-level category"
},
{
"name" : "service-type",
"definition" : "http://hl7.org/fhir/SearchParameter/Schedule-service-type",
"type" : "token",
"documentation" : "The type of appointments that can be booked into associated slot(s)"
},
{
"name" : "active",
"definition" : "http://hl7.org/fhir/SearchParameter/Schedule-active",
"type" : "token",
"documentation" : "Is the schedule in active use"
}]
},
{
"type" : "SearchParameter",
"profile" : "http://hl7.org/fhir/StructureDefinition/SearchParameter",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["SearchParameter.derived-from",
"SearchParameter.component"],
"searchRevInclude" : ["SearchParameter.derived-from",
"SearchParameter.component"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-date",
"type" : "date",
"documentation" : "The search parameter publication date"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/SearchParameter-code",
"type" : "token",
"documentation" : "Code used in URL"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the search parameter"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the search parameter"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-description",
"type" : "string",
"documentation" : "The description of the search parameter"
},
{
"name" : "derived-from",
"definition" : "http://hl7.org/fhir/SearchParameter/SearchParameter-derived-from",
"type" : "reference",
"documentation" : "Original definition for the search parameter"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the search parameter"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/SearchParameter-type",
"type" : "token",
"documentation" : "number | date | string | token | reference | composite | quantity | uri | special"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-version",
"type" : "token",
"documentation" : "The business version of the search parameter"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-url",
"type" : "uri",
"documentation" : "The uri that identifies the search parameter"
},
{
"name" : "target",
"definition" : "http://hl7.org/fhir/SearchParameter/SearchParameter-target",
"type" : "token",
"documentation" : "Types of resource (if a resource reference)"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the search parameter"
},
{
"name" : "component",
"definition" : "http://hl7.org/fhir/SearchParameter/SearchParameter-component",
"type" : "reference",
"documentation" : "Defines how the part works"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-name",
"type" : "string",
"documentation" : "Computationally friendly name of the search parameter"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context",
"type" : "token",
"documentation" : "A use context assigned to the search parameter"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the search parameter"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the search parameter"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-status",
"type" : "token",
"documentation" : "The current status of the search parameter"
},
{
"name" : "base",
"definition" : "http://hl7.org/fhir/SearchParameter/SearchParameter-base",
"type" : "token",
"documentation" : "The resource type(s) this search parameter applies to"
}]
},
{
"type" : "ServiceRequest",
"profile" : "http://hl7.org/fhir/StructureDefinition/ServiceRequest",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["ServiceRequest.requester",
"ServiceRequest.performer",
"ServiceRequest.replaces",
"ServiceRequest.subject",
"ServiceRequest.instantiates-canonical",
"ServiceRequest.encounter",
"ServiceRequest.based-on",
"ServiceRequest.patient",
"ServiceRequest.specimen"],
"searchRevInclude" : ["Appointment.based-on",
"CarePlan.activity-reference",
"DiagnosticReport.based-on",
"Encounter.based-on",
"EpisodeOfCare.incoming-referral",
"ImagingStudy.basedon",
"Media.based-on",
"Observation.based-on",
"Procedure.based-on",
"QuestionnaireResponse.based-on",
"ServiceRequest.replaces",
"ServiceRequest.based-on"],
"searchParam" : [{
"name" : "authored",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-authored",
"type" : "date",
"documentation" : "Date request signed"
},
{
"name" : "requester",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-requester",
"type" : "reference",
"documentation" : "Who/what is requesting service"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "Identifiers assigned to this order"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "What is being requested/ordered"
},
{
"name" : "performer",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-performer",
"type" : "reference",
"documentation" : "Requested performer"
},
{
"name" : "requisition",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-requisition",
"type" : "token",
"documentation" : "Composite Request ID"
},
{
"name" : "replaces",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-replaces",
"type" : "reference",
"documentation" : "What request replaces"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-subject",
"type" : "reference",
"documentation" : "Search by subject"
},
{
"name" : "instantiates-canonical",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-instantiates-canonical",
"type" : "reference",
"documentation" : "Instantiates FHIR protocol or definition"
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type" : "reference",
"documentation" : "An encounter in which this request is made"
},
{
"name" : "occurrence",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-occurrence",
"type" : "date",
"documentation" : "When service should occur"
},
{
"name" : "priority",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-priority",
"type" : "token",
"documentation" : "routine | urgent | asap | stat"
},
{
"name" : "intent",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-intent",
"type" : "token",
"documentation" : "proposal | plan | order +"
},
{
"name" : "performer-type",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-performer-type",
"type" : "token",
"documentation" : "Performer role"
},
{
"name" : "based-on",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-based-on",
"type" : "reference",
"documentation" : "What request fulfills"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Search by subject - a patient"
},
{
"name" : "specimen",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-specimen",
"type" : "reference",
"documentation" : "Specimen to be tested"
},
{
"name" : "instantiates-uri",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-instantiates-uri",
"type" : "uri",
"documentation" : "Instantiates external protocol or definition"
},
{
"name" : "body-site",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-body-site",
"type" : "token",
"documentation" : "Where procedure is going to be done"
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-category",
"type" : "token",
"documentation" : "Classification of service"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-status",
"type" : "token",
"documentation" : "draft | active | suspended | completed | entered-in-error | cancelled"
}]
},
{
"type" : "Slot",
"profile" : "http://hl7.org/fhir/StructureDefinition/Slot",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Slot.schedule"],
"searchRevInclude" : ["Appointment.slot"],
"searchParam" : [{
"name" : "schedule",
"definition" : "http://hl7.org/fhir/SearchParameter/Slot-schedule",
"type" : "reference",
"documentation" : "The Schedule Resource that we are seeking a slot within"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Slot-identifier",
"type" : "token",
"documentation" : "A Slot Identifier"
},
{
"name" : "specialty",
"definition" : "http://hl7.org/fhir/SearchParameter/Slot-specialty",
"type" : "token",
"documentation" : "The specialty of a practitioner that would be required to perform the service requested in this appointment"
},
{
"name" : "service-category",
"definition" : "http://hl7.org/fhir/SearchParameter/Slot-service-category",
"type" : "token",
"documentation" : "A broad categorization of the service that is to be performed during this appointment"
},
{
"name" : "appointment-type",
"definition" : "http://hl7.org/fhir/SearchParameter/Slot-appointment-type",
"type" : "token",
"documentation" : "The style of appointment or patient that may be booked in the slot (not service type)"
},
{
"name" : "service-type",
"definition" : "http://hl7.org/fhir/SearchParameter/Slot-service-type",
"type" : "token",
"documentation" : "The type of appointments that can be booked into the slot"
},
{
"name" : "start",
"definition" : "http://hl7.org/fhir/SearchParameter/Slot-start",
"type" : "date",
"documentation" : "Appointment date/time."
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Slot-status",
"type" : "token",
"documentation" : "The free/busy status of the appointment"
}]
},
{
"type" : "Specimen",
"profile" : "http://hl7.org/fhir/StructureDefinition/Specimen",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Specimen.parent",
"Specimen.subject",
"Specimen.patient",
"Specimen.collector"],
"searchRevInclude" : ["DiagnosticReport.specimen",
"Media.subject",
"Media.patient",
"Observation.specimen",
"ServiceRequest.specimen",
"Specimen.parent"],
"searchParam" : [{
"name" : "container",
"definition" : "http://hl7.org/fhir/SearchParameter/Specimen-container",
"type" : "token",
"documentation" : "The kind of specimen container"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Specimen-identifier",
"type" : "token",
"documentation" : "The unique identifier associated with the specimen"
},
{
"name" : "parent",
"definition" : "http://hl7.org/fhir/SearchParameter/Specimen-parent",
"type" : "reference",
"documentation" : "The parent of the specimen"
},
{
"name" : "container-id",
"definition" : "http://hl7.org/fhir/SearchParameter/Specimen-container-id",
"type" : "token",
"documentation" : "The unique identifier associated with the specimen container"
},
{
"name" : "bodysite",
"definition" : "http://hl7.org/fhir/SearchParameter/Specimen-bodysite",
"type" : "token",
"documentation" : "The code for the body site from where the specimen originated"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/Specimen-subject",
"type" : "reference",
"documentation" : "The subject of the specimen"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/Specimen-patient",
"type" : "reference",
"documentation" : "The patient the specimen comes from"
},
{
"name" : "collected",
"definition" : "http://hl7.org/fhir/SearchParameter/Specimen-collected",
"type" : "date",
"documentation" : "The date the specimen was collected"
},
{
"name" : "accession",
"definition" : "http://hl7.org/fhir/SearchParameter/Specimen-accession",
"type" : "token",
"documentation" : "The accession number associated with the specimen"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/Specimen-type",
"type" : "token",
"documentation" : "The specimen type"
},
{
"name" : "collector",
"definition" : "http://hl7.org/fhir/SearchParameter/Specimen-collector",
"type" : "reference",
"documentation" : "Who collected the specimen"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Specimen-status",
"type" : "token",
"documentation" : "available | unavailable | unsatisfactory | entered-in-error"
}]
},
{
"type" : "SpecimenDefinition",
"profile" : "http://hl7.org/fhir/StructureDefinition/SpecimenDefinition",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchParam" : [{
"name" : "container",
"definition" : "http://hl7.org/fhir/SearchParameter/SpecimenDefinition-container",
"type" : "token",
"documentation" : "The type of specimen conditioned in container expected by the lab"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/SpecimenDefinition-identifier",
"type" : "token",
"documentation" : "The unique identifier associated with the specimen"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/SpecimenDefinition-type",
"type" : "token",
"documentation" : "The type of collected specimen"
}]
},
{
"type" : "StructureDefinition",
"profile" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["StructureDefinition.valueset",
"StructureDefinition.base"],
"searchRevInclude" : ["CapabilityStatement.resource-profile",
"CapabilityStatement.supported-profile",
"ImplementationGuide.global",
"OperationDefinition.input-profile",
"OperationDefinition.output-profile",
"StructureDefinition.base"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-date",
"type" : "date",
"documentation" : "The structure definition publication date"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the structure definition"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the structure definition"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-description",
"type" : "string",
"documentation" : "The description of the structure definition"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the structure definition"
},
{
"name" : "experimental",
"definition" : "http://hl7.org/fhir/SearchParameter/StructureDefinition-experimental",
"type" : "token",
"documentation" : "For testing purposes, not real usage"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-title",
"type" : "string",
"documentation" : "The human-friendly name of the structure definition"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/StructureDefinition-type",
"type" : "uri",
"documentation" : "Type defined or constrained by this structure"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the structure definition"
},
{
"name" : "path",
"definition" : "http://hl7.org/fhir/SearchParameter/StructureDefinition-path",
"type" : "token",
"documentation" : "A path that is constrained in the StructureDefinition"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context",
"type" : "token",
"documentation" : "A use context assigned to the structure definition"
},
{
"name" : "base-path",
"definition" : "http://hl7.org/fhir/SearchParameter/StructureDefinition-base-path",
"type" : "token",
"documentation" : "Path that identifies the base element"
},
{
"name" : "keyword",
"definition" : "http://hl7.org/fhir/SearchParameter/StructureDefinition-keyword",
"type" : "token",
"documentation" : "A code for the StructureDefinition"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the structure definition"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-identifier",
"type" : "token",
"documentation" : "External identifier for the structure definition"
},
{
"name" : "valueset",
"definition" : "http://hl7.org/fhir/SearchParameter/StructureDefinition-valueset",
"type" : "reference",
"documentation" : "A vocabulary binding reference"
},
{
"name" : "kind",
"definition" : "http://hl7.org/fhir/SearchParameter/StructureDefinition-kind",
"type" : "token",
"documentation" : "primitive-type | complex-type | resource | logical"
},
{
"name" : "abstract",
"definition" : "http://hl7.org/fhir/SearchParameter/StructureDefinition-abstract",
"type" : "token",
"documentation" : "Whether the structure is abstract"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-version",
"type" : "token",
"documentation" : "The business version of the structure definition"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-url",
"type" : "uri",
"documentation" : "The uri that identifies the structure definition"
},
{
"name" : "ext-context",
"definition" : "http://hl7.org/fhir/SearchParameter/StructureDefinition-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",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-name",
"type" : "string",
"documentation" : "Computationally friendly name of the structure definition"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the structure definition"
},
{
"name" : "derivation",
"definition" : "http://hl7.org/fhir/SearchParameter/StructureDefinition-derivation",
"type" : "token",
"documentation" : "specialization | constraint - How relates to base definition"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-status",
"type" : "token",
"documentation" : "The current status of the structure definition"
},
{
"name" : "base",
"definition" : "http://hl7.org/fhir/SearchParameter/StructureDefinition-base",
"type" : "reference",
"documentation" : "Definition that this type is constrained/specialized from"
}]
},
{
"type" : "StructureMap",
"profile" : "http://hl7.org/fhir/StructureDefinition/StructureMap",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-date",
"type" : "date",
"documentation" : "The structure map publication date"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-identifier",
"type" : "token",
"documentation" : "External identifier for the structure map"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the structure map"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the structure map"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-description",
"type" : "string",
"documentation" : "The description of the structure map"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the structure map"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-title",
"type" : "string",
"documentation" : "The human-friendly name of the structure map"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-version",
"type" : "token",
"documentation" : "The business version of the structure map"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-url",
"type" : "uri",
"documentation" : "The uri that identifies the structure map"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the structure map"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-name",
"type" : "string",
"documentation" : "Computationally friendly name of the structure map"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context",
"type" : "token",
"documentation" : "A use context assigned to the structure map"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the structure map"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the structure map"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-status",
"type" : "token",
"documentation" : "The current status of the structure map"
}]
},
{
"type" : "Subscription",
"profile" : "http://hl7.org/fhir/StructureDefinition/Subscription",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchParam" : [{
"name" : "payload",
"definition" : "http://hl7.org/fhir/SearchParameter/Subscription-payload",
"type" : "token",
"documentation" : "The mime-type of the notification payload"
},
{
"name" : "criteria",
"definition" : "http://hl7.org/fhir/SearchParameter/Subscription-criteria",
"type" : "string",
"documentation" : "The search rules used to determine when to send a notification"
},
{
"name" : "contact",
"definition" : "http://hl7.org/fhir/SearchParameter/Subscription-contact",
"type" : "token",
"documentation" : "Contact details for the subscription"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/Subscription-type",
"type" : "token",
"documentation" : "The type of channel for the sent notifications"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/Subscription-url",
"type" : "uri",
"documentation" : "The uri that will receive the notifications"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Subscription-status",
"type" : "token",
"documentation" : "The current state of the subscription"
}]
},
{
"type" : "Substance",
"profile" : "http://hl7.org/fhir/StructureDefinition/Substance",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Substance.substance-reference"],
"searchRevInclude" : ["AdverseEvent.substance",
"Group.member",
"Medication.ingredient",
"MedicationKnowledge.ingredient",
"MedicinalProductInteraction.subject",
"Specimen.subject",
"Specimen.patient",
"Substance.substance-reference"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Substance-identifier",
"type" : "token",
"documentation" : "Unique identifier for the substance"
},
{
"name" : "container-identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Substance-container-identifier",
"type" : "token",
"documentation" : "Identifier of the package/container"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/Substance-code",
"type" : "token",
"documentation" : "The code of the substance or ingredient"
},
{
"name" : "quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/Substance-quantity",
"type" : "quantity",
"documentation" : "Amount of substance in the package"
},
{
"name" : "substance-reference",
"definition" : "http://hl7.org/fhir/SearchParameter/Substance-substance-reference",
"type" : "reference",
"documentation" : "A component of the substance"
},
{
"name" : "expiry",
"definition" : "http://hl7.org/fhir/SearchParameter/Substance-expiry",
"type" : "date",
"documentation" : "Expiry date of package or container of substance"
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Substance-category",
"type" : "token",
"documentation" : "The category of the substance"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Substance-status",
"type" : "token",
"documentation" : "active | inactive | entered-in-error"
}]
},
{
"type" : "SubstanceNucleicAcid",
"profile" : "http://hl7.org/fhir/StructureDefinition/SubstanceNucleicAcid",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"]
},
{
"type" : "SubstancePolymer",
"profile" : "http://hl7.org/fhir/StructureDefinition/SubstancePolymer",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"]
},
{
"type" : "SubstanceProtein",
"profile" : "http://hl7.org/fhir/StructureDefinition/SubstanceProtein",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"]
},
{
"type" : "SubstanceReferenceInformation",
"profile" : "http://hl7.org/fhir/StructureDefinition/SubstanceReferenceInformation",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"]
},
{
"type" : "SubstanceSourceMaterial",
"profile" : "http://hl7.org/fhir/StructureDefinition/SubstanceSourceMaterial",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"]
},
{
"type" : "SubstanceSpecification",
"profile" : "http://hl7.org/fhir/StructureDefinition/SubstanceSpecification",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchParam" : [{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/SubstanceSpecification-code",
"type" : "token",
"documentation" : "Codes associated with the substance"
}]
},
{
"type" : "SupplyDelivery",
"profile" : "http://hl7.org/fhir/StructureDefinition/SupplyDelivery",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["SupplyDelivery.receiver",
"SupplyDelivery.patient",
"SupplyDelivery.supplier"],
"searchRevInclude" : ["ChargeItem.service"],
"searchParam" : [{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "External identifier"
},
{
"name" : "receiver",
"definition" : "http://hl7.org/fhir/SearchParameter/SupplyDelivery-receiver",
"type" : "reference",
"documentation" : "Who collected the Supply"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Patient for whom the item is supplied"
},
{
"name" : "supplier",
"definition" : "http://hl7.org/fhir/SearchParameter/SupplyDelivery-supplier",
"type" : "reference",
"documentation" : "Dispenser"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/SupplyDelivery-status",
"type" : "token",
"documentation" : "in-progress | completed | abandoned | entered-in-error"
}]
},
{
"type" : "SupplyRequest",
"profile" : "http://hl7.org/fhir/StructureDefinition/SupplyRequest",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["SupplyRequest.requester",
"SupplyRequest.subject",
"SupplyRequest.supplier"],
"searchParam" : [{
"name" : "requester",
"definition" : "http://hl7.org/fhir/SearchParameter/SupplyRequest-requester",
"type" : "reference",
"documentation" : "Individual making the request"
},
{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "When the request was made"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "Business Identifier for SupplyRequest"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/SupplyRequest-subject",
"type" : "reference",
"documentation" : "The destination of the supply"
},
{
"name" : "supplier",
"definition" : "http://hl7.org/fhir/SearchParameter/SupplyRequest-supplier",
"type" : "reference",
"documentation" : "Who is intended to fulfill the request"
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/SupplyRequest-category",
"type" : "token",
"documentation" : "The kind of supply (central, non-stock, etc.)"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/SupplyRequest-status",
"type" : "token",
"documentation" : "draft | active | suspended +"
}]
},
{
"type" : "Task",
"profile" : "http://hl7.org/fhir/StructureDefinition/Task",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["Task.owner",
"Task.requester",
"Task.subject",
"Task.focus",
"Task.part-of",
"Task.encounter",
"Task.based-on",
"Task.patient"],
"searchRevInclude" : ["CarePlan.activity-reference",
"ImagingStudy.basedon",
"PaymentReconciliation.request",
"Task.part-of"],
"searchParam" : [{
"name" : "owner",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-owner",
"type" : "reference",
"documentation" : "Search by task owner"
},
{
"name" : "requester",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-requester",
"type" : "reference",
"documentation" : "Search by task requester"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-identifier",
"type" : "token",
"documentation" : "Search for a task instance by its business identifier"
},
{
"name" : "business-status",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-business-status",
"type" : "token",
"documentation" : "Search by business status"
},
{
"name" : "period",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-period",
"type" : "date",
"documentation" : "Search by period Task is/was underway"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-code",
"type" : "token",
"documentation" : "Search by task code"
},
{
"name" : "performer",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-performer",
"type" : "token",
"documentation" : "Search by recommended type of performer (e.g., Requester, Performer, Scheduler)."
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-subject",
"type" : "reference",
"documentation" : "Search by subject"
},
{
"name" : "focus",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-focus",
"type" : "reference",
"documentation" : "Search by task focus"
},
{
"name" : "part-of",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-part-of",
"type" : "reference",
"documentation" : "Search by task this task is part of"
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-encounter",
"type" : "reference",
"documentation" : "Search by encounter"
},
{
"name" : "priority",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-priority",
"type" : "token",
"documentation" : "Search by task priority"
},
{
"name" : "authored-on",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-authored-on",
"type" : "date",
"documentation" : "Search by creation date"
},
{
"name" : "intent",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-intent",
"type" : "token",
"documentation" : "Search by task intent"
},
{
"name" : "group-identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-group-identifier",
"type" : "token",
"documentation" : "Search by group identifier"
},
{
"name" : "based-on",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-based-on",
"type" : "reference",
"documentation" : "Search by requests this task is based on"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-patient",
"type" : "reference",
"documentation" : "Search by patient"
},
{
"name" : "modified",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-modified",
"type" : "date",
"documentation" : "Search by last modification date"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-status",
"type" : "token",
"documentation" : "Search by task status"
}]
},
{
"type" : "TerminologyCapabilities",
"profile" : "http://hl7.org/fhir/StructureDefinition/TerminologyCapabilities",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-date",
"type" : "date",
"documentation" : "The terminology capabilities publication date"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the terminology capabilities"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the terminology capabilities"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-description",
"type" : "string",
"documentation" : "The description of the terminology capabilities"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the terminology capabilities"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-title",
"type" : "string",
"documentation" : "The human-friendly name of the terminology capabilities"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-version",
"type" : "token",
"documentation" : "The business version of the terminology capabilities"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-url",
"type" : "uri",
"documentation" : "The uri that identifies the terminology capabilities"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the terminology capabilities"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-name",
"type" : "string",
"documentation" : "Computationally friendly name of the terminology capabilities"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context",
"type" : "token",
"documentation" : "A use context assigned to the terminology capabilities"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the terminology capabilities"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the terminology capabilities"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-status",
"type" : "token",
"documentation" : "The current status of the terminology capabilities"
}]
},
{
"type" : "TestReport",
"profile" : "http://hl7.org/fhir/StructureDefinition/TestReport",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["TestReport.testscript"],
"searchParam" : [{
"name" : "result",
"definition" : "http://hl7.org/fhir/SearchParameter/TestReport-result",
"type" : "token",
"documentation" : "The result disposition of the test execution"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/TestReport-identifier",
"type" : "token",
"documentation" : "An external identifier for the test report"
},
{
"name" : "tester",
"definition" : "http://hl7.org/fhir/SearchParameter/TestReport-tester",
"type" : "string",
"documentation" : "The name of the testing organization"
},
{
"name" : "testscript",
"definition" : "http://hl7.org/fhir/SearchParameter/TestReport-testscript",
"type" : "reference",
"documentation" : "The test script executed to produce this report"
},
{
"name" : "issued",
"definition" : "http://hl7.org/fhir/SearchParameter/TestReport-issued",
"type" : "date",
"documentation" : "The test report generation date"
},
{
"name" : "participant",
"definition" : "http://hl7.org/fhir/SearchParameter/TestReport-participant",
"type" : "uri",
"documentation" : "The reference to a participant in the test execution"
}]
},
{
"type" : "TestScript",
"profile" : "http://hl7.org/fhir/StructureDefinition/TestScript",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchRevInclude" : ["TestReport.testscript"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/TestScript-date",
"type" : "date",
"documentation" : "The test script publication date"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/TestScript-identifier",
"type" : "token",
"documentation" : "External identifier for the test script"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/TestScript-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the test script"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/TestScript-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the test script"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/TestScript-description",
"type" : "string",
"documentation" : "The description of the test script"
},
{
"name" : "testscript-capability",
"definition" : "http://hl7.org/fhir/SearchParameter/TestScript-testscript-capability",
"type" : "string",
"documentation" : "TestScript required and validated capability"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/TestScript-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the test script"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/TestScript-title",
"type" : "string",
"documentation" : "The human-friendly name of the test script"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/TestScript-version",
"type" : "token",
"documentation" : "The business version of the test script"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/TestScript-url",
"type" : "uri",
"documentation" : "The uri that identifies the test script"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/TestScript-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the test script"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/TestScript-name",
"type" : "string",
"documentation" : "Computationally friendly name of the test script"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/TestScript-context",
"type" : "token",
"documentation" : "A use context assigned to the test script"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/TestScript-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the test script"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/TestScript-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the test script"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/TestScript-status",
"type" : "token",
"documentation" : "The current status of the test script"
}]
},
{
"type" : "ValueSet",
"profile" : "http://hl7.org/fhir/StructureDefinition/ValueSet",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchRevInclude" : ["ConceptMap.source",
"ConceptMap.source-uri",
"ConceptMap.target-uri",
"ConceptMap.target",
"StructureDefinition.valueset"],
"searchParam" : [{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-date",
"type" : "date",
"documentation" : "The value set publication date"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-identifier",
"type" : "token",
"documentation" : "External identifier for the value set"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/ValueSet-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",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the value set"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the value set"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-description",
"type" : "string",
"documentation" : "The description of the value set"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the value set"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-title",
"type" : "string",
"documentation" : "The human-friendly name of the value set"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-version",
"type" : "token",
"documentation" : "The business version of the value set"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-url",
"type" : "uri",
"documentation" : "The uri that identifies the value set"
},
{
"name" : "expansion",
"definition" : "http://hl7.org/fhir/SearchParameter/ValueSet-expansion",
"type" : "uri",
"documentation" : "Identifies the value set expansion (business identifier)"
},
{
"name" : "reference",
"definition" : "http://hl7.org/fhir/SearchParameter/ValueSet-reference",
"type" : "uri",
"documentation" : "A code system included or excluded in the value set or an imported value set"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the value set"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-name",
"type" : "string",
"documentation" : "Computationally friendly name of the value set"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context",
"type" : "token",
"documentation" : "A use context assigned to the value set"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the value set"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the value set"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-status",
"type" : "token",
"documentation" : "The current status of the value set"
}]
},
{
"type" : "VerificationResult",
"profile" : "http://hl7.org/fhir/StructureDefinition/VerificationResult",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["VerificationResult.target"],
"searchParam" : [{
"name" : "target",
"definition" : "http://hl7.org/fhir/SearchParameter/VerificationResult-target",
"type" : "reference",
"documentation" : "A resource that was validated"
}]
},
{
"type" : "VisionPrescription",
"profile" : "http://hl7.org/fhir/StructureDefinition/VisionPrescription",
"interaction" : [{
"code" : "read",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "update",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "create",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : ["literal",
"logical"],
"searchInclude" : ["VisionPrescription.prescriber",
"VisionPrescription.patient",
"VisionPrescription.encounter"],
"searchRevInclude" : ["CarePlan.activity-reference"],
"searchParam" : [{
"name" : "prescriber",
"definition" : "http://hl7.org/fhir/SearchParameter/VisionPrescription-prescriber",
"type" : "reference",
"documentation" : "Who authorized the vision prescription"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "Return prescriptions with this external identifier"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The identity of a patient to list dispenses for"
},
{
"name" : "datewritten",
"definition" : "http://hl7.org/fhir/SearchParameter/VisionPrescription-datewritten",
"type" : "date",
"documentation" : "Return prescriptions written on this date"
},
{
"name" : "encounter",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type" : "reference",
"documentation" : "Return prescriptions with this encounter identifier"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/VisionPrescription-status",
"type" : "token",
"documentation" : "The status of the vision prescription"
}]
}],
"interaction" : [{
"code" : "transaction",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "batch",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "history-system",
"documentation" : "Implemented per the specification (or Insert other doco here)"
},
{
"code" : "search-system",
"documentation" : "Implemented per the specification (or Insert other doco here)"
}],
"searchParam" : [{
"name" : "_text",
"definition" : "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type" : "string",
"documentation" : "Search on the narrative of the resource"
},
{
"name" : "something",
"definition" : "http://hl7.org/fhir/SearchParameter/id",
"type" : "string",
"documentation" : "some doco"
},
{
"name" : "_list",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-list",
"type" : "token",
"documentation" : "Retrieval of resources that are referenced by a List resource"
},
{
"name" : "_has",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-has",
"type" : "composite",
"documentation" : "Provides support for reverse chaining"
},
{
"name" : "_type",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-type",
"type" : "token",
"documentation" : "Type of resource (when doing cross-resource search"
},
{
"name" : "_sort",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-source",
"type" : "token",
"documentation" : "How to sort the resources when returning"
},
{
"name" : "_count",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-count",
"type" : "number",
"documentation" : "How many resources to return"
},
{
"name" : "_include",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-include",
"type" : "token",
"documentation" : "Control over returning additional resources (see spec)"
},
{
"name" : "_revinclude",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-revinclude",
"type" : "token",
"documentation" : "Control over returning additional resources (see spec)"
},
{
"name" : "_summary",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-summary",
"type" : "token",
"documentation" : "What kind of information to return"
},
{
"name" : "_elements",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-elements",
"type" : "string",
"documentation" : "What kind of information to return"
},
{
"name" : "_contained",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-contained",
"type" : "token",
"documentation" : "Managing search into contained resources"
},
{
"name" : "_containedType",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-containedType",
"type" : "token",
"documentation" : "Managing search into contained resources"
},
{
"name" : "something",
"definition" : "http://hl7.org/fhir/SearchParameter/id",
"type" : "string",
"documentation" : "some doco"
},
{
"name" : "_list",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-list",
"type" : "token",
"documentation" : "Retrieval of resources that are referenced by a List resource"
},
{
"name" : "_has",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-has",
"type" : "composite",
"documentation" : "Provides support for reverse chaining"
},
{
"name" : "_type",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-type",
"type" : "token",
"documentation" : "Type of resource (when doing cross-resource search"
},
{
"name" : "_sort",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-source",
"type" : "token",
"documentation" : "How to sort the resources when returning"
},
{
"name" : "_count",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-count",
"type" : "number",
"documentation" : "How many resources to return"
},
{
"name" : "_include",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-include",
"type" : "token",
"documentation" : "Control over returning additional resources (see spec)"
},
{
"name" : "_revinclude",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-revinclude",
"type" : "token",
"documentation" : "Control over returning additional resources (see spec)"
},
{
"name" : "_summary",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-summary",
"type" : "token",
"documentation" : "What kind of information to return"
},
{
"name" : "_elements",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-elements",
"type" : "string",
"documentation" : "What kind of information to return"
},
{
"name" : "_contained",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-contained",
"type" : "token",
"documentation" : "Managing search into contained resources"
},
{
"name" : "_containedType",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-containedType",
"type" : "token",
"documentation" : "Managing search into contained resources"
},
{
"name" : "_query",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-query",
"type" : "token",
"documentation" : "A custom search profile that describes a specific defined query operation"
},
{
"name" : "_profile",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type" : "reference",
"documentation" : "Profiles this resource claims to conform to"
},
{
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
},
{
"name" : "_tag",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type" : "token",
"documentation" : "Tags applied to this resource"
},
{
"name" : "_security",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-security",
"type" : "token",
"documentation" : "Security Labels applied to this resource"
},
{
"name" : "_source",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-source",
"type" : "uri",
"documentation" : "Identifies where the resource comes from"
},
{
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Logical id of this artifact"
},
{
"name" : "_content",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-content",
"type" : "string",
"documentation" : "Search on the entire content of the resource"
},
{
"name" : "something",
"definition" : "http://hl7.org/fhir/SearchParameter/id",
"type" : "string",
"documentation" : "some doco"
},
{
"name" : "_list",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-list",
"type" : "token",
"documentation" : "Retrieval of resources that are referenced by a List resource"
},
{
"name" : "_has",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-has",
"type" : "composite",
"documentation" : "Provides support for reverse chaining"
},
{
"name" : "_type",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-type",
"type" : "token",
"documentation" : "Type of resource (when doing cross-resource search"
},
{
"name" : "_sort",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-source",
"type" : "token",
"documentation" : "How to sort the resources when returning"
},
{
"name" : "_count",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-count",
"type" : "number",
"documentation" : "How many resources to return"
},
{
"name" : "_include",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-include",
"type" : "token",
"documentation" : "Control over returning additional resources (see spec)"
},
{
"name" : "_revinclude",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-revinclude",
"type" : "token",
"documentation" : "Control over returning additional resources (see spec)"
},
{
"name" : "_summary",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-summary",
"type" : "token",
"documentation" : "What kind of information to return"
},
{
"name" : "_elements",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-elements",
"type" : "string",
"documentation" : "What kind of information to return"
},
{
"name" : "_contained",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-contained",
"type" : "token",
"documentation" : "Managing search into contained resources"
},
{
"name" : "_containedType",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-containedType",
"type" : "token",
"documentation" : "Managing search into contained resources"
}],
"operation" : [{
"name" : "validate",
"definition" : "http://hl7.org/fhir/OperationDefinition/resource-validate"
},
{
"name" : "meta",
"definition" : "http://hl7.org/fhir/OperationDefinition/resource-meta"
},
{
"name" : "meta-add",
"definition" : "http://hl7.org/fhir/OperationDefinition/resource-meta-add"
},
{
"name" : "meta-delete",
"definition" : "http://hl7.org/fhir/OperationDefinition/resource-meta-delete"
},
{
"name" : "convert",
"definition" : "http://hl7.org/fhir/OperationDefinition/resource-convert"
},
{
"name" : "graphql",
"definition" : "http://hl7.org/fhir/OperationDefinition/resource-graphql"
},
{
"name" : "graph",
"definition" : "http://hl7.org/fhir/OperationDefinition/resource-graph"
},
{
"name" : "apply",
"definition" : "http://hl7.org/fhir/OperationDefinition/activitydefinition-apply"
},
{
"name" : "data-requirements",
"definition" : "http://hl7.org/fhir/OperationDefinition/activitydefinition-data-requirements"
},
{
"name" : "subset",
"definition" : "http://hl7.org/fhir/OperationDefinition/capabilitystatement-subset"
},
{
"name" : "implements",
"definition" : "http://hl7.org/fhir/OperationDefinition/capabilitystatement-implements"
},
{
"name" : "conforms",
"definition" : "http://hl7.org/fhir/OperationDefinition/capabilitystatement-conforms"
},
{
"name" : "versions",
"definition" : "http://hl7.org/fhir/OperationDefinition/capabilitystatement-versions"
},
{
"name" : "apply",
"definition" : "http://hl7.org/fhir/OperationDefinition/chargeitemdefinition-apply"
},
{
"name" : "submit",
"definition" : "http://hl7.org/fhir/OperationDefinition/claim-submit"
},
{
"name" : "lookup",
"definition" : "http://hl7.org/fhir/OperationDefinition/codesystem-lookup"
},
{
"name" : "validate-code",
"definition" : "http://hl7.org/fhir/OperationDefinition/codesystem-validate-code"
},
{
"name" : "subsumes",
"definition" : "http://hl7.org/fhir/OperationDefinition/codesystem-subsumes"
},
{
"name" : "find-matches",
"definition" : "http://hl7.org/fhir/OperationDefinition/codesystem-find-matches"
},
{
"name" : "document",
"definition" : "http://hl7.org/fhir/OperationDefinition/composition-document"
},
{
"name" : "translate",
"definition" : "http://hl7.org/fhir/OperationDefinition/conceptmap-translate"
},
{
"name" : "closure",
"definition" : "http://hl7.org/fhir/OperationDefinition/conceptmap-closure"
},
{
"name" : "submit",
"definition" : "http://hl7.org/fhir/OperationDefinition/coverageeligibilityrequest-submit"
},
{
"name" : "everything",
"definition" : "http://hl7.org/fhir/OperationDefinition/encounter-everything"
},
{
"name" : "everything",
"definition" : "http://hl7.org/fhir/OperationDefinition/group-everything"
},
{
"name" : "data-requirements",
"definition" : "http://hl7.org/fhir/OperationDefinition/library-data-requirements"
},
{
"name" : "find",
"definition" : "http://hl7.org/fhir/OperationDefinition/list-find"
},
{
"name" : "evaluate-measure",
"definition" : "http://hl7.org/fhir/OperationDefinition/measure-evaluate-measure"
},
{
"name" : "data-requirements",
"definition" : "http://hl7.org/fhir/OperationDefinition/measure-data-requirements"
},
{
"name" : "submit-data",
"definition" : "http://hl7.org/fhir/OperationDefinition/measure-submit-data"
},
{
"name" : "collect-data",
"definition" : "http://hl7.org/fhir/OperationDefinition/measure-collect-data"
},
{
"name" : "care-gaps",
"definition" : "http://hl7.org/fhir/OperationDefinition/measure-care-gaps"
},
{
"name" : "everything",
"definition" : "http://hl7.org/fhir/OperationDefinition/medicinalproduct-everything"
},
{
"name" : "process-message",
"definition" : "http://hl7.org/fhir/OperationDefinition/messageheader-process-message"
},
{
"name" : "preferred-id",
"definition" : "http://hl7.org/fhir/OperationDefinition/namingsystem-preferred-id"
},
{
"name" : "stats",
"definition" : "http://hl7.org/fhir/OperationDefinition/observation-stats"
},
{
"name" : "lastn",
"definition" : "http://hl7.org/fhir/OperationDefinition/observation-lastn"
},
{
"name" : "match",
"definition" : "http://hl7.org/fhir/OperationDefinition/patient-match"
},
{
"name" : "everything",
"definition" : "http://hl7.org/fhir/OperationDefinition/patient-everything"
},
{
"name" : "apply",
"definition" : "http://hl7.org/fhir/OperationDefinition/plandefinition-apply"
},
{
"name" : "data-requirements",
"definition" : "http://hl7.org/fhir/OperationDefinition/plandefinition-data-requirements"
},
{
"name" : "questionnaire",
"definition" : "http://hl7.org/fhir/OperationDefinition/structuredefinition-questionnaire"
},
{
"name" : "snapshot",
"definition" : "http://hl7.org/fhir/OperationDefinition/structuredefinition-snapshot"
},
{
"name" : "transform",
"definition" : "http://hl7.org/fhir/OperationDefinition/structuremap-transform"
},
{
"name" : "expand",
"definition" : "http://hl7.org/fhir/OperationDefinition/valueset-expand"
},
{
"name" : "validate-code",
"definition" : "http://hl7.org/fhir/OperationDefinition/valueset-validate-code"
}]
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/CapabilityStatement/base2",
"resource" : {
"resourceType" : "CapabilityStatement",
"id" : "base2",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Base FHIR Capability Statement (Empty)
This is the base Capability Statement for FHIR. It represents a server that provides the none of the functionality defined by FHIR. It is provided to use as a template for system designers to build their own Capability Statements from. A capability statement has to contain something, so this contains a read of a Capability Statement
\nMode SERVER Description An empty Capability Statement Transaction System History System Search
Resource Type Profile Read V-Read Search Update Updates Create Delete History CapabilityStatement y
Base FHIR Capability Statement (Empty)
This is the base Capability Statement for FHIR. It represents a server that provides the none of the functionality defined by FHIR. It is provided to use as a template for system designers to build their own Capability Statements from. A capability statement has to contain something, so this contains a read of a Capability Statement
\nMode SERVER Description An empty Capability Statement Transaction System History System Search
Resource Type Profile Read V-Read Search Update Updates Create Delete History CapabilityStatement y
"
},
"url" : "http://hl7.org/fhir/CapabilityStatement/base2",
"version" : "4.0.0",
"name" : "Base FHIR Capability Statement (Empty)",
"status" : "draft",
"experimental" : true,
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "FHIR Project Team",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
}],
"description" : "This is the base Capability Statement for FHIR. It represents a server that provides the none of the functionality defined by FHIR. It is provided to use as a template for system designers to build their own Capability Statements from. A capability statement has to contain something, so this contains a read of a Capability Statement",
"kind" : "capability",
"software" : {
"name" : "Insert your software name here..."
},
"fhirVersion" : "4.0.0",
"format" : ["xml",
"json"],
"rest" : [{
"mode" : "server",
"documentation" : "An empty Capability Statement",
"security" : {
"cors" : true,
"service" : [{
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/restful-security-service",
"code" : "SMART-on-FHIR",
"display" : "SMART-on-FHIR"
}],
"text" : "See http://docs.smarthealthit.org/"
}],
"description" : "This is the Capability Statement to declare that the server supports SMART-on-FHIR. See the SMART-on-FHIR docs for the extension that would go with such a server"
},
"resource" : [{
"type" : "CapabilityStatement",
"interaction" : [{
"code" : "read",
"documentation" : "Read CapabilityStatement Resource"
}]
}]
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/CompartmentDefinition/device",
"resource" : {
"resourceType" : "CompartmentDefinition",
"id" : "device",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "\r\nThe following resources may be in this compartment:\r\n
\r\n\r\n Resource Inclusion Criteria \r\n Account subject \r\n Appointment actor \r\n AppointmentResponse actor \r\n AuditEvent agent \r\n ChargeItem enterer, performer-actor \r\n Claim procedure-udi, item-udi, detail-udi, subdetail-udi \r\n Communication sender, recipient \r\n CommunicationRequest sender, recipient \r\n Composition author \r\n DetectedIssue author \r\n DeviceRequest device, subject, requester, performer \r\n DeviceUseStatement device \r\n DiagnosticReport subject \r\n DocumentManifest subject, author \r\n DocumentReference subject, author \r\n ExplanationOfBenefit procedure-udi, item-udi, detail-udi, subdetail-udi \r\n Flag author \r\n Group member \r\n Invoice participant \r\n List subject, source \r\n Media subject \r\n MedicationAdministration device \r\n MessageHeader target \r\n Observation subject, device \r\n Provenance agent \r\n QuestionnaireResponse author \r\n RequestGroup author \r\n RiskAssessment performer \r\n Schedule actor \r\n ServiceRequest performer, requester \r\n Specimen subject \r\n SupplyRequest requester \r\n
\r\n\r\nA resource is in this compartment if the nominated search parameter (or chain) refers to the patient resource that defines the compartment.\r\n
\r\n\r\n\r\n
\r\n\r\nThe following resources are never in this compartment:\r\n
\r\n\r\n - ActivityDefinition
\r\n - AdverseEvent
\r\n - AllergyIntolerance
\r\n - Basic
\r\n - Binary
\r\n - BiologicallyDerivedProduct
\r\n - BodyStructure
\r\n - Bundle
\r\n - CapabilityStatement
\r\n - CarePlan
\r\n - CareTeam
\r\n - CatalogEntry
\r\n - ChargeItemDefinition
\r\n - ClaimResponse
\r\n - ClinicalImpression
\r\n - CodeSystem
\r\n - CompartmentDefinition
\r\n - ConceptMap
\r\n - Condition
\r\n - Consent
\r\n - Contract
\r\n - Coverage
\r\n - CoverageEligibilityRequest
\r\n - CoverageEligibilityResponse
\r\n - Device
\r\n - DeviceDefinition
\r\n - DeviceMetric
\r\n - EffectEvidenceSynthesis
\r\n - Encounter
\r\n - Endpoint
\r\n - EnrollmentRequest
\r\n - EnrollmentResponse
\r\n - EpisodeOfCare
\r\n - EventDefinition
\r\n - Evidence
\r\n - EvidenceVariable
\r\n - ExampleScenario
\r\n - FamilyMemberHistory
\r\n - Goal
\r\n - GraphDefinition
\r\n - GuidanceResponse
\r\n - HealthcareService
\r\n - ImagingStudy
\r\n - Immunization
\r\n - ImmunizationEvaluation
\r\n - ImmunizationRecommendation
\r\n - ImplementationGuide
\r\n - InsurancePlan
\r\n - Library
\r\n - Linkage
\r\n - Location
\r\n - Measure
\r\n - MeasureReport
\r\n - Medication
\r\n - MedicationDispense
\r\n - MedicationKnowledge
\r\n - MedicationRequest
\r\n - MedicationStatement
\r\n - MedicinalProduct
\r\n - MedicinalProductAuthorization
\r\n - MedicinalProductContraindication
\r\n - MedicinalProductIndication
\r\n - MedicinalProductIngredient
\r\n - MedicinalProductInteraction
\r\n - MedicinalProductManufactured
\r\n - MedicinalProductPackaged
\r\n - MedicinalProductPharmaceutical
\r\n - MedicinalProductUndesirableEffect
\r\n - MessageDefinition
\r\n - MolecularSequence
\r\n - NamingSystem
\r\n - NutritionOrder
\r\n - ObservationDefinition
\r\n - OperationDefinition
\r\n - OperationOutcome
\r\n - Organization
\r\n - OrganizationAffiliation
\r\n - Patient
\r\n - PaymentNotice
\r\n - PaymentReconciliation
\r\n - Person
\r\n - PlanDefinition
\r\n - Practitioner
\r\n - PractitionerRole
\r\n - Procedure
\r\n - Questionnaire
\r\n - RelatedPerson
\r\n - ResearchDefinition
\r\n - ResearchElementDefinition
\r\n - ResearchStudy
\r\n - ResearchSubject
\r\n - RiskEvidenceSynthesis
\r\n - SearchParameter
\r\n - Slot
\r\n - SpecimenDefinition
\r\n - StructureDefinition
\r\n - StructureMap
\r\n - Subscription
\r\n - Substance
\r\n - SubstanceNucleicAcid
\r\n - SubstancePolymer
\r\n - SubstanceProtein
\r\n - SubstanceReferenceInformation
\r\n - SubstanceSourceMaterial
\r\n - SubstanceSpecification
\r\n - SupplyDelivery
\r\n - Task
\r\n - TerminologyCapabilities
\r\n - TestReport
\r\n - TestScript
\r\n - ValueSet
\r\n - VerificationResult
\r\n - VisionPrescription
\r\n
"
},
"url" : "http://hl7.org/fhir/CompartmentDefinition/device",
"version" : "4.0.0",
"name" : "Base FHIR compartment definition for Device",
"status" : "draft",
"experimental" : true,
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "FHIR Project Team",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
}],
"description" : "There is an instance of the device compartment for each Device resource, and the identity of the compartment is the same as the Device. The set of resources associated with a particular device",
"code" : "Device",
"search" : true,
"resource" : [{
"code" : "Account",
"param" : ["subject"]
},
{
"code" : "ActivityDefinition"
},
{
"code" : "AdverseEvent"
},
{
"code" : "AllergyIntolerance"
},
{
"code" : "Appointment",
"param" : ["actor"]
},
{
"code" : "AppointmentResponse",
"param" : ["actor"]
},
{
"code" : "AuditEvent",
"param" : ["agent"]
},
{
"code" : "Basic"
},
{
"code" : "Binary"
},
{
"code" : "BiologicallyDerivedProduct"
},
{
"code" : "BodyStructure"
},
{
"code" : "Bundle"
},
{
"code" : "CapabilityStatement"
},
{
"code" : "CarePlan"
},
{
"code" : "CareTeam"
},
{
"code" : "CatalogEntry"
},
{
"code" : "ChargeItem",
"param" : ["enterer",
"performer-actor"]
},
{
"code" : "ChargeItemDefinition"
},
{
"code" : "Claim",
"param" : ["procedure-udi",
"item-udi",
"detail-udi",
"subdetail-udi"]
},
{
"code" : "ClaimResponse"
},
{
"code" : "ClinicalImpression"
},
{
"code" : "CodeSystem"
},
{
"code" : "Communication",
"param" : ["sender",
"recipient"]
},
{
"code" : "CommunicationRequest",
"param" : ["sender",
"recipient"]
},
{
"code" : "CompartmentDefinition"
},
{
"code" : "Composition",
"param" : ["author"]
},
{
"code" : "ConceptMap"
},
{
"code" : "Condition"
},
{
"code" : "Consent"
},
{
"code" : "Contract"
},
{
"code" : "Coverage"
},
{
"code" : "CoverageEligibilityRequest"
},
{
"code" : "CoverageEligibilityResponse"
},
{
"code" : "DetectedIssue",
"param" : ["author"]
},
{
"code" : "Device"
},
{
"code" : "DeviceDefinition"
},
{
"code" : "DeviceMetric"
},
{
"code" : "DeviceRequest",
"param" : ["device",
"subject",
"requester",
"performer"]
},
{
"code" : "DeviceUseStatement",
"param" : ["device"]
},
{
"code" : "DiagnosticReport",
"param" : ["subject"]
},
{
"code" : "DocumentManifest",
"param" : ["subject",
"author"]
},
{
"code" : "DocumentReference",
"param" : ["subject",
"author"]
},
{
"code" : "EffectEvidenceSynthesis"
},
{
"code" : "Encounter"
},
{
"code" : "Endpoint"
},
{
"code" : "EnrollmentRequest"
},
{
"code" : "EnrollmentResponse"
},
{
"code" : "EpisodeOfCare"
},
{
"code" : "EventDefinition"
},
{
"code" : "Evidence"
},
{
"code" : "EvidenceVariable"
},
{
"code" : "ExampleScenario"
},
{
"code" : "ExplanationOfBenefit",
"param" : ["procedure-udi",
"item-udi",
"detail-udi",
"subdetail-udi"]
},
{
"code" : "FamilyMemberHistory"
},
{
"code" : "Flag",
"param" : ["author"]
},
{
"code" : "Goal"
},
{
"code" : "GraphDefinition"
},
{
"code" : "Group",
"param" : ["member"]
},
{
"code" : "GuidanceResponse"
},
{
"code" : "HealthcareService"
},
{
"code" : "ImagingStudy"
},
{
"code" : "Immunization"
},
{
"code" : "ImmunizationEvaluation"
},
{
"code" : "ImmunizationRecommendation"
},
{
"code" : "ImplementationGuide"
},
{
"code" : "InsurancePlan"
},
{
"code" : "Invoice",
"param" : ["participant"]
},
{
"code" : "Library"
},
{
"code" : "Linkage"
},
{
"code" : "List",
"param" : ["subject",
"source"]
},
{
"code" : "Location"
},
{
"code" : "Measure"
},
{
"code" : "MeasureReport"
},
{
"code" : "Media",
"param" : ["subject"]
},
{
"code" : "Medication"
},
{
"code" : "MedicationAdministration",
"param" : ["device"]
},
{
"code" : "MedicationDispense"
},
{
"code" : "MedicationKnowledge"
},
{
"code" : "MedicationRequest"
},
{
"code" : "MedicationStatement"
},
{
"code" : "MedicinalProduct"
},
{
"code" : "MedicinalProductAuthorization"
},
{
"code" : "MedicinalProductContraindication"
},
{
"code" : "MedicinalProductIndication"
},
{
"code" : "MedicinalProductIngredient"
},
{
"code" : "MedicinalProductInteraction"
},
{
"code" : "MedicinalProductManufactured"
},
{
"code" : "MedicinalProductPackaged"
},
{
"code" : "MedicinalProductPharmaceutical"
},
{
"code" : "MedicinalProductUndesirableEffect"
},
{
"code" : "MessageDefinition"
},
{
"code" : "MessageHeader",
"param" : ["target"]
},
{
"code" : "MolecularSequence"
},
{
"code" : "NamingSystem"
},
{
"code" : "NutritionOrder"
},
{
"code" : "Observation",
"param" : ["subject",
"device"]
},
{
"code" : "ObservationDefinition"
},
{
"code" : "OperationDefinition"
},
{
"code" : "OperationOutcome"
},
{
"code" : "Organization"
},
{
"code" : "OrganizationAffiliation"
},
{
"code" : "Patient"
},
{
"code" : "PaymentNotice"
},
{
"code" : "PaymentReconciliation"
},
{
"code" : "Person"
},
{
"code" : "PlanDefinition"
},
{
"code" : "Practitioner"
},
{
"code" : "PractitionerRole"
},
{
"code" : "Procedure"
},
{
"code" : "Provenance",
"param" : ["agent"]
},
{
"code" : "Questionnaire"
},
{
"code" : "QuestionnaireResponse",
"param" : ["author"]
},
{
"code" : "RelatedPerson"
},
{
"code" : "RequestGroup",
"param" : ["author"]
},
{
"code" : "ResearchDefinition"
},
{
"code" : "ResearchElementDefinition"
},
{
"code" : "ResearchStudy"
},
{
"code" : "ResearchSubject"
},
{
"code" : "RiskAssessment",
"param" : ["performer"]
},
{
"code" : "RiskEvidenceSynthesis"
},
{
"code" : "Schedule",
"param" : ["actor"]
},
{
"code" : "SearchParameter"
},
{
"code" : "ServiceRequest",
"param" : ["performer",
"requester"]
},
{
"code" : "Slot"
},
{
"code" : "Specimen",
"param" : ["subject"]
},
{
"code" : "SpecimenDefinition"
},
{
"code" : "StructureDefinition"
},
{
"code" : "StructureMap"
},
{
"code" : "Subscription"
},
{
"code" : "Substance"
},
{
"code" : "SubstanceNucleicAcid"
},
{
"code" : "SubstancePolymer"
},
{
"code" : "SubstanceProtein"
},
{
"code" : "SubstanceReferenceInformation"
},
{
"code" : "SubstanceSourceMaterial"
},
{
"code" : "SubstanceSpecification"
},
{
"code" : "SupplyDelivery"
},
{
"code" : "SupplyRequest",
"param" : ["requester"]
},
{
"code" : "Task"
},
{
"code" : "TerminologyCapabilities"
},
{
"code" : "TestReport"
},
{
"code" : "TestScript"
},
{
"code" : "ValueSet"
},
{
"code" : "VerificationResult"
},
{
"code" : "VisionPrescription"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/CompartmentDefinition/encounter",
"resource" : {
"resourceType" : "CompartmentDefinition",
"id" : "encounter",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "\r\nThe following resources may be in this compartment:\r\n
\r\n\r\n Resource Inclusion Criteria \r\n CarePlan encounter \r\n CareTeam encounter \r\n ChargeItem context \r\n Claim encounter \r\n ClinicalImpression encounter \r\n Communication encounter \r\n CommunicationRequest encounter \r\n Composition encounter \r\n Condition encounter \r\n DeviceRequest encounter \r\n DiagnosticReport encounter \r\n DocumentManifest related-ref \r\n DocumentReference encounter \r\n Encounter {def} \r\n ExplanationOfBenefit encounter \r\n Media encounter \r\n MedicationAdministration context \r\n MedicationRequest encounter \r\n NutritionOrder encounter \r\n Observation encounter \r\n Procedure encounter \r\n QuestionnaireResponse encounter \r\n RequestGroup encounter \r\n ServiceRequest encounter \r\n VisionPrescription encounter \r\n
\r\n\r\nA resource is in this compartment if the nominated search parameter (or chain) refers to the patient resource that defines the compartment.\r\n
\r\n\r\n\r\n
\r\n\r\nThe following resources are never in this compartment:\r\n
\r\n\r\n - Account
\r\n - ActivityDefinition
\r\n - AdverseEvent
\r\n - AllergyIntolerance
\r\n - Appointment
\r\n - AppointmentResponse
\r\n - AuditEvent
\r\n - Basic
\r\n - Binary
\r\n - BiologicallyDerivedProduct
\r\n - BodyStructure
\r\n - Bundle
\r\n - CapabilityStatement
\r\n - CatalogEntry
\r\n - ChargeItemDefinition
\r\n - ClaimResponse
\r\n - CodeSystem
\r\n - CompartmentDefinition
\r\n - ConceptMap
\r\n - Consent
\r\n - Contract
\r\n - Coverage
\r\n - CoverageEligibilityRequest
\r\n - CoverageEligibilityResponse
\r\n - DetectedIssue
\r\n - Device
\r\n - DeviceDefinition
\r\n - DeviceMetric
\r\n - DeviceUseStatement
\r\n - EffectEvidenceSynthesis
\r\n - Endpoint
\r\n - EnrollmentRequest
\r\n - EnrollmentResponse
\r\n - EpisodeOfCare
\r\n - EventDefinition
\r\n - Evidence
\r\n - EvidenceVariable
\r\n - ExampleScenario
\r\n - FamilyMemberHistory
\r\n - Flag
\r\n - Goal
\r\n - GraphDefinition
\r\n - Group
\r\n - GuidanceResponse
\r\n - HealthcareService
\r\n - ImagingStudy
\r\n - Immunization
\r\n - ImmunizationEvaluation
\r\n - ImmunizationRecommendation
\r\n - ImplementationGuide
\r\n - InsurancePlan
\r\n - Invoice
\r\n - Library
\r\n - Linkage
\r\n - List
\r\n - Location
\r\n - Measure
\r\n - MeasureReport
\r\n - Medication
\r\n - MedicationDispense
\r\n - MedicationKnowledge
\r\n - MedicationStatement
\r\n - MedicinalProduct
\r\n - MedicinalProductAuthorization
\r\n - MedicinalProductContraindication
\r\n - MedicinalProductIndication
\r\n - MedicinalProductIngredient
\r\n - MedicinalProductInteraction
\r\n - MedicinalProductManufactured
\r\n - MedicinalProductPackaged
\r\n - MedicinalProductPharmaceutical
\r\n - MedicinalProductUndesirableEffect
\r\n - MessageDefinition
\r\n - MessageHeader
\r\n - MolecularSequence
\r\n - NamingSystem
\r\n - ObservationDefinition
\r\n - OperationDefinition
\r\n - OperationOutcome
\r\n - Organization
\r\n - OrganizationAffiliation
\r\n - Patient
\r\n - PaymentNotice
\r\n - PaymentReconciliation
\r\n - Person
\r\n - PlanDefinition
\r\n - Practitioner
\r\n - PractitionerRole
\r\n - Provenance
\r\n - Questionnaire
\r\n - RelatedPerson
\r\n - ResearchDefinition
\r\n - ResearchElementDefinition
\r\n - ResearchStudy
\r\n - ResearchSubject
\r\n - RiskAssessment
\r\n - RiskEvidenceSynthesis
\r\n - Schedule
\r\n - SearchParameter
\r\n - Slot
\r\n - Specimen
\r\n - SpecimenDefinition
\r\n - StructureDefinition
\r\n - StructureMap
\r\n - Subscription
\r\n - Substance
\r\n - SubstanceNucleicAcid
\r\n - SubstancePolymer
\r\n - SubstanceProtein
\r\n - SubstanceReferenceInformation
\r\n - SubstanceSourceMaterial
\r\n - SubstanceSpecification
\r\n - SupplyDelivery
\r\n - SupplyRequest
\r\n - Task
\r\n - TerminologyCapabilities
\r\n - TestReport
\r\n - TestScript
\r\n - ValueSet
\r\n - VerificationResult
\r\n
"
},
"url" : "http://hl7.org/fhir/CompartmentDefinition/encounter",
"version" : "4.0.0",
"name" : "Base FHIR compartment definition for Encounter",
"status" : "draft",
"experimental" : true,
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "FHIR Project Team",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
}],
"description" : "There is an instance of the encounter compartment for each encounter resource, and the identity of the compartment is the same as the encounter. The set of resources associated with a particular encounter",
"code" : "Encounter",
"search" : true,
"resource" : [{
"code" : "Account"
},
{
"code" : "ActivityDefinition"
},
{
"code" : "AdverseEvent"
},
{
"code" : "AllergyIntolerance"
},
{
"code" : "Appointment"
},
{
"code" : "AppointmentResponse"
},
{
"code" : "AuditEvent"
},
{
"code" : "Basic"
},
{
"code" : "Binary"
},
{
"code" : "BiologicallyDerivedProduct"
},
{
"code" : "BodyStructure"
},
{
"code" : "Bundle"
},
{
"code" : "CapabilityStatement"
},
{
"code" : "CarePlan",
"param" : ["encounter"]
},
{
"code" : "CareTeam",
"param" : ["encounter"]
},
{
"code" : "CatalogEntry"
},
{
"code" : "ChargeItem",
"param" : ["context"]
},
{
"code" : "ChargeItemDefinition"
},
{
"code" : "Claim",
"param" : ["encounter"]
},
{
"code" : "ClaimResponse"
},
{
"code" : "ClinicalImpression",
"param" : ["encounter"]
},
{
"code" : "CodeSystem"
},
{
"code" : "Communication",
"param" : ["encounter"]
},
{
"code" : "CommunicationRequest",
"param" : ["encounter"]
},
{
"code" : "CompartmentDefinition"
},
{
"code" : "Composition",
"param" : ["encounter"]
},
{
"code" : "ConceptMap"
},
{
"code" : "Condition",
"param" : ["encounter"]
},
{
"code" : "Consent"
},
{
"code" : "Contract"
},
{
"code" : "Coverage"
},
{
"code" : "CoverageEligibilityRequest"
},
{
"code" : "CoverageEligibilityResponse"
},
{
"code" : "DetectedIssue"
},
{
"code" : "Device"
},
{
"code" : "DeviceDefinition"
},
{
"code" : "DeviceMetric"
},
{
"code" : "DeviceRequest",
"param" : ["encounter"]
},
{
"code" : "DeviceUseStatement"
},
{
"code" : "DiagnosticReport",
"param" : ["encounter"]
},
{
"code" : "DocumentManifest",
"param" : ["related-ref"]
},
{
"code" : "DocumentReference",
"param" : ["encounter"]
},
{
"code" : "EffectEvidenceSynthesis"
},
{
"code" : "Encounter",
"param" : ["{def}"]
},
{
"code" : "Endpoint"
},
{
"code" : "EnrollmentRequest"
},
{
"code" : "EnrollmentResponse"
},
{
"code" : "EpisodeOfCare"
},
{
"code" : "EventDefinition"
},
{
"code" : "Evidence"
},
{
"code" : "EvidenceVariable"
},
{
"code" : "ExampleScenario"
},
{
"code" : "ExplanationOfBenefit",
"param" : ["encounter"]
},
{
"code" : "FamilyMemberHistory"
},
{
"code" : "Flag"
},
{
"code" : "Goal"
},
{
"code" : "GraphDefinition"
},
{
"code" : "Group"
},
{
"code" : "GuidanceResponse"
},
{
"code" : "HealthcareService"
},
{
"code" : "ImagingStudy"
},
{
"code" : "Immunization"
},
{
"code" : "ImmunizationEvaluation"
},
{
"code" : "ImmunizationRecommendation"
},
{
"code" : "ImplementationGuide"
},
{
"code" : "InsurancePlan"
},
{
"code" : "Invoice"
},
{
"code" : "Library"
},
{
"code" : "Linkage"
},
{
"code" : "List"
},
{
"code" : "Location"
},
{
"code" : "Measure"
},
{
"code" : "MeasureReport"
},
{
"code" : "Media",
"param" : ["encounter"]
},
{
"code" : "Medication"
},
{
"code" : "MedicationAdministration",
"param" : ["context"]
},
{
"code" : "MedicationDispense"
},
{
"code" : "MedicationKnowledge"
},
{
"code" : "MedicationRequest",
"param" : ["encounter"]
},
{
"code" : "MedicationStatement"
},
{
"code" : "MedicinalProduct"
},
{
"code" : "MedicinalProductAuthorization"
},
{
"code" : "MedicinalProductContraindication"
},
{
"code" : "MedicinalProductIndication"
},
{
"code" : "MedicinalProductIngredient"
},
{
"code" : "MedicinalProductInteraction"
},
{
"code" : "MedicinalProductManufactured"
},
{
"code" : "MedicinalProductPackaged"
},
{
"code" : "MedicinalProductPharmaceutical"
},
{
"code" : "MedicinalProductUndesirableEffect"
},
{
"code" : "MessageDefinition"
},
{
"code" : "MessageHeader"
},
{
"code" : "MolecularSequence"
},
{
"code" : "NamingSystem"
},
{
"code" : "NutritionOrder",
"param" : ["encounter"]
},
{
"code" : "Observation",
"param" : ["encounter"]
},
{
"code" : "ObservationDefinition"
},
{
"code" : "OperationDefinition"
},
{
"code" : "OperationOutcome"
},
{
"code" : "Organization"
},
{
"code" : "OrganizationAffiliation"
},
{
"code" : "Patient"
},
{
"code" : "PaymentNotice"
},
{
"code" : "PaymentReconciliation"
},
{
"code" : "Person"
},
{
"code" : "PlanDefinition"
},
{
"code" : "Practitioner"
},
{
"code" : "PractitionerRole"
},
{
"code" : "Procedure",
"param" : ["encounter"]
},
{
"code" : "Provenance"
},
{
"code" : "Questionnaire"
},
{
"code" : "QuestionnaireResponse",
"param" : ["encounter"]
},
{
"code" : "RelatedPerson"
},
{
"code" : "RequestGroup",
"param" : ["encounter"]
},
{
"code" : "ResearchDefinition"
},
{
"code" : "ResearchElementDefinition"
},
{
"code" : "ResearchStudy"
},
{
"code" : "ResearchSubject"
},
{
"code" : "RiskAssessment"
},
{
"code" : "RiskEvidenceSynthesis"
},
{
"code" : "Schedule"
},
{
"code" : "SearchParameter"
},
{
"code" : "ServiceRequest",
"param" : ["encounter"]
},
{
"code" : "Slot"
},
{
"code" : "Specimen"
},
{
"code" : "SpecimenDefinition"
},
{
"code" : "StructureDefinition"
},
{
"code" : "StructureMap"
},
{
"code" : "Subscription"
},
{
"code" : "Substance"
},
{
"code" : "SubstanceNucleicAcid"
},
{
"code" : "SubstancePolymer"
},
{
"code" : "SubstanceProtein"
},
{
"code" : "SubstanceReferenceInformation"
},
{
"code" : "SubstanceSourceMaterial"
},
{
"code" : "SubstanceSpecification"
},
{
"code" : "SupplyDelivery"
},
{
"code" : "SupplyRequest"
},
{
"code" : "Task"
},
{
"code" : "TerminologyCapabilities"
},
{
"code" : "TestReport"
},
{
"code" : "TestScript"
},
{
"code" : "ValueSet"
},
{
"code" : "VerificationResult"
},
{
"code" : "VisionPrescription",
"param" : ["encounter"]
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/CompartmentDefinition/patient",
"resource" : {
"resourceType" : "CompartmentDefinition",
"id" : "patient",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "\r\nThe following resources may be in this compartment:\r\n
\r\n\r\n Resource Inclusion Criteria \r\n Account subject \r\n AdverseEvent subject \r\n AllergyIntolerance patient, recorder, asserter \r\n Appointment actor \r\n AppointmentResponse actor \r\n AuditEvent patient \r\n Basic patient, author \r\n BodyStructure patient \r\n CarePlan patient, performer \r\n CareTeam patient, participant \r\n ChargeItem subject \r\n Claim patient, payee \r\n ClaimResponse patient \r\n ClinicalImpression subject \r\n Communication subject, sender, recipient \r\n CommunicationRequest subject, sender, recipient, requester \r\n Composition subject, author, attester \r\n Condition patient, asserter \r\n Consent patient \r\n Coverage policy-holder, subscriber, beneficiary, payor \r\n CoverageEligibilityRequest patient \r\n CoverageEligibilityResponse patient \r\n DetectedIssue patient \r\n DeviceRequest subject, performer \r\n DeviceUseStatement subject \r\n DiagnosticReport subject \r\n DocumentManifest subject, author, recipient \r\n DocumentReference subject, author \r\n Encounter patient \r\n EnrollmentRequest subject \r\n EpisodeOfCare patient \r\n ExplanationOfBenefit patient, payee \r\n FamilyMemberHistory patient \r\n Flag patient \r\n Goal patient \r\n Group member \r\n ImagingStudy patient \r\n Immunization patient \r\n ImmunizationEvaluation patient \r\n ImmunizationRecommendation patient \r\n Invoice subject, patient, recipient \r\n List subject, source \r\n MeasureReport patient \r\n Media subject \r\n MedicationAdministration patient, performer, subject \r\n MedicationDispense subject, patient, receiver \r\n MedicationRequest subject \r\n MedicationStatement subject \r\n MolecularSequence patient \r\n NutritionOrder patient \r\n Observation subject, performer \r\n Patient link \r\n Person patient \r\n Procedure patient, performer \r\n Provenance patient \r\n QuestionnaireResponse subject, author \r\n RelatedPerson patient \r\n RequestGroup subject, participant \r\n ResearchSubject individual \r\n RiskAssessment subject \r\n Schedule actor \r\n ServiceRequest subject, performer \r\n Specimen subject \r\n SupplyDelivery patient \r\n SupplyRequest subject \r\n VisionPrescription patient \r\n
\r\n\r\nA resource is in this compartment if the nominated search parameter (or chain) refers to the patient resource that defines the compartment.\r\n
\r\n\r\n\r\n
\r\n\r\nThe following resources are never in this compartment:\r\n
\r\n\r\n - ActivityDefinition
\r\n - Binary
\r\n - BiologicallyDerivedProduct
\r\n - Bundle
\r\n - CapabilityStatement
\r\n - CatalogEntry
\r\n - ChargeItemDefinition
\r\n - CodeSystem
\r\n - CompartmentDefinition
\r\n - ConceptMap
\r\n - Contract
\r\n - Device
\r\n - DeviceDefinition
\r\n - DeviceMetric
\r\n - EffectEvidenceSynthesis
\r\n - Endpoint
\r\n - EnrollmentResponse
\r\n - EventDefinition
\r\n - Evidence
\r\n - EvidenceVariable
\r\n - ExampleScenario
\r\n - GraphDefinition
\r\n - GuidanceResponse
\r\n - HealthcareService
\r\n - ImplementationGuide
\r\n - InsurancePlan
\r\n - Library
\r\n - Linkage
\r\n - Location
\r\n - Measure
\r\n - Medication
\r\n - MedicationKnowledge
\r\n - MedicinalProduct
\r\n - MedicinalProductAuthorization
\r\n - MedicinalProductContraindication
\r\n - MedicinalProductIndication
\r\n - MedicinalProductIngredient
\r\n - MedicinalProductInteraction
\r\n - MedicinalProductManufactured
\r\n - MedicinalProductPackaged
\r\n - MedicinalProductPharmaceutical
\r\n - MedicinalProductUndesirableEffect
\r\n - MessageDefinition
\r\n - MessageHeader
\r\n - NamingSystem
\r\n - ObservationDefinition
\r\n - OperationDefinition
\r\n - OperationOutcome
\r\n - Organization
\r\n - OrganizationAffiliation
\r\n - PaymentNotice
\r\n - PaymentReconciliation
\r\n - PlanDefinition
\r\n - Practitioner
\r\n - PractitionerRole
\r\n - Questionnaire
\r\n - ResearchDefinition
\r\n - ResearchElementDefinition
\r\n - ResearchStudy
\r\n - RiskEvidenceSynthesis
\r\n - SearchParameter
\r\n - Slot
\r\n - SpecimenDefinition
\r\n - StructureDefinition
\r\n - StructureMap
\r\n - Subscription
\r\n - Substance
\r\n - SubstanceNucleicAcid
\r\n - SubstancePolymer
\r\n - SubstanceProtein
\r\n - SubstanceReferenceInformation
\r\n - SubstanceSourceMaterial
\r\n - SubstanceSpecification
\r\n - Task
\r\n - TerminologyCapabilities
\r\n - TestReport
\r\n - TestScript
\r\n - ValueSet
\r\n - VerificationResult
\r\n
"
},
"url" : "http://hl7.org/fhir/CompartmentDefinition/patient",
"version" : "4.0.0",
"name" : "Base FHIR compartment definition for Patient",
"status" : "draft",
"experimental" : true,
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "FHIR Project Team",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
}],
"description" : "There is an instance of the patient compartment for each patient resource, and the identity of the compartment is the same as the patient. When a patient is linked to another patient, all the records associated with the linked patient are in the compartment associated with the target of the link.. The set of resources associated with a particular patient",
"code" : "Patient",
"search" : true,
"resource" : [{
"code" : "Account",
"param" : ["subject"]
},
{
"code" : "ActivityDefinition"
},
{
"code" : "AdverseEvent",
"param" : ["subject"]
},
{
"code" : "AllergyIntolerance",
"param" : ["patient",
"recorder",
"asserter"]
},
{
"code" : "Appointment",
"param" : ["actor"]
},
{
"code" : "AppointmentResponse",
"param" : ["actor"]
},
{
"code" : "AuditEvent",
"param" : ["patient"]
},
{
"code" : "Basic",
"param" : ["patient",
"author"]
},
{
"code" : "Binary"
},
{
"code" : "BiologicallyDerivedProduct"
},
{
"code" : "BodyStructure",
"param" : ["patient"]
},
{
"code" : "Bundle"
},
{
"code" : "CapabilityStatement"
},
{
"code" : "CarePlan",
"param" : ["patient",
"performer"]
},
{
"code" : "CareTeam",
"param" : ["patient",
"participant"]
},
{
"code" : "CatalogEntry"
},
{
"code" : "ChargeItem",
"param" : ["subject"]
},
{
"code" : "ChargeItemDefinition"
},
{
"code" : "Claim",
"param" : ["patient",
"payee"]
},
{
"code" : "ClaimResponse",
"param" : ["patient"]
},
{
"code" : "ClinicalImpression",
"param" : ["subject"]
},
{
"code" : "CodeSystem"
},
{
"code" : "Communication",
"param" : ["subject",
"sender",
"recipient"]
},
{
"code" : "CommunicationRequest",
"param" : ["subject",
"sender",
"recipient",
"requester"]
},
{
"code" : "CompartmentDefinition"
},
{
"code" : "Composition",
"param" : ["subject",
"author",
"attester"]
},
{
"code" : "ConceptMap"
},
{
"code" : "Condition",
"param" : ["patient",
"asserter"]
},
{
"code" : "Consent",
"param" : ["patient"]
},
{
"code" : "Contract"
},
{
"code" : "Coverage",
"param" : ["policy-holder",
"subscriber",
"beneficiary",
"payor"]
},
{
"code" : "CoverageEligibilityRequest",
"param" : ["patient"]
},
{
"code" : "CoverageEligibilityResponse",
"param" : ["patient"]
},
{
"code" : "DetectedIssue",
"param" : ["patient"]
},
{
"code" : "Device"
},
{
"code" : "DeviceDefinition"
},
{
"code" : "DeviceMetric"
},
{
"code" : "DeviceRequest",
"param" : ["subject",
"performer"]
},
{
"code" : "DeviceUseStatement",
"param" : ["subject"]
},
{
"code" : "DiagnosticReport",
"param" : ["subject"]
},
{
"code" : "DocumentManifest",
"param" : ["subject",
"author",
"recipient"]
},
{
"code" : "DocumentReference",
"param" : ["subject",
"author"]
},
{
"code" : "EffectEvidenceSynthesis"
},
{
"code" : "Encounter",
"param" : ["patient"]
},
{
"code" : "Endpoint"
},
{
"code" : "EnrollmentRequest",
"param" : ["subject"]
},
{
"code" : "EnrollmentResponse"
},
{
"code" : "EpisodeOfCare",
"param" : ["patient"]
},
{
"code" : "EventDefinition"
},
{
"code" : "Evidence"
},
{
"code" : "EvidenceVariable"
},
{
"code" : "ExampleScenario"
},
{
"code" : "ExplanationOfBenefit",
"param" : ["patient",
"payee"]
},
{
"code" : "FamilyMemberHistory",
"param" : ["patient"]
},
{
"code" : "Flag",
"param" : ["patient"]
},
{
"code" : "Goal",
"param" : ["patient"]
},
{
"code" : "GraphDefinition"
},
{
"code" : "Group",
"param" : ["member"]
},
{
"code" : "GuidanceResponse"
},
{
"code" : "HealthcareService"
},
{
"code" : "ImagingStudy",
"param" : ["patient"]
},
{
"code" : "Immunization",
"param" : ["patient"]
},
{
"code" : "ImmunizationEvaluation",
"param" : ["patient"]
},
{
"code" : "ImmunizationRecommendation",
"param" : ["patient"]
},
{
"code" : "ImplementationGuide"
},
{
"code" : "InsurancePlan"
},
{
"code" : "Invoice",
"param" : ["subject",
"patient",
"recipient"]
},
{
"code" : "Library"
},
{
"code" : "Linkage"
},
{
"code" : "List",
"param" : ["subject",
"source"]
},
{
"code" : "Location"
},
{
"code" : "Measure"
},
{
"code" : "MeasureReport",
"param" : ["patient"]
},
{
"code" : "Media",
"param" : ["subject"]
},
{
"code" : "Medication"
},
{
"code" : "MedicationAdministration",
"param" : ["patient",
"performer",
"subject"]
},
{
"code" : "MedicationDispense",
"param" : ["subject",
"patient",
"receiver"]
},
{
"code" : "MedicationKnowledge"
},
{
"code" : "MedicationRequest",
"param" : ["subject"]
},
{
"code" : "MedicationStatement",
"param" : ["subject"]
},
{
"code" : "MedicinalProduct"
},
{
"code" : "MedicinalProductAuthorization"
},
{
"code" : "MedicinalProductContraindication"
},
{
"code" : "MedicinalProductIndication"
},
{
"code" : "MedicinalProductIngredient"
},
{
"code" : "MedicinalProductInteraction"
},
{
"code" : "MedicinalProductManufactured"
},
{
"code" : "MedicinalProductPackaged"
},
{
"code" : "MedicinalProductPharmaceutical"
},
{
"code" : "MedicinalProductUndesirableEffect"
},
{
"code" : "MessageDefinition"
},
{
"code" : "MessageHeader"
},
{
"code" : "MolecularSequence",
"param" : ["patient"]
},
{
"code" : "NamingSystem"
},
{
"code" : "NutritionOrder",
"param" : ["patient"]
},
{
"code" : "Observation",
"param" : ["subject",
"performer"]
},
{
"code" : "ObservationDefinition"
},
{
"code" : "OperationDefinition"
},
{
"code" : "OperationOutcome"
},
{
"code" : "Organization"
},
{
"code" : "OrganizationAffiliation"
},
{
"code" : "Patient",
"param" : ["link"]
},
{
"code" : "PaymentNotice"
},
{
"code" : "PaymentReconciliation"
},
{
"code" : "Person",
"param" : ["patient"]
},
{
"code" : "PlanDefinition"
},
{
"code" : "Practitioner"
},
{
"code" : "PractitionerRole"
},
{
"code" : "Procedure",
"param" : ["patient",
"performer"]
},
{
"code" : "Provenance",
"param" : ["patient"]
},
{
"code" : "Questionnaire"
},
{
"code" : "QuestionnaireResponse",
"param" : ["subject",
"author"]
},
{
"code" : "RelatedPerson",
"param" : ["patient"]
},
{
"code" : "RequestGroup",
"param" : ["subject",
"participant"]
},
{
"code" : "ResearchDefinition"
},
{
"code" : "ResearchElementDefinition"
},
{
"code" : "ResearchStudy"
},
{
"code" : "ResearchSubject",
"param" : ["individual"]
},
{
"code" : "RiskAssessment",
"param" : ["subject"]
},
{
"code" : "RiskEvidenceSynthesis"
},
{
"code" : "Schedule",
"param" : ["actor"]
},
{
"code" : "SearchParameter"
},
{
"code" : "ServiceRequest",
"param" : ["subject",
"performer"]
},
{
"code" : "Slot"
},
{
"code" : "Specimen",
"param" : ["subject"]
},
{
"code" : "SpecimenDefinition"
},
{
"code" : "StructureDefinition"
},
{
"code" : "StructureMap"
},
{
"code" : "Subscription"
},
{
"code" : "Substance"
},
{
"code" : "SubstanceNucleicAcid"
},
{
"code" : "SubstancePolymer"
},
{
"code" : "SubstanceProtein"
},
{
"code" : "SubstanceReferenceInformation"
},
{
"code" : "SubstanceSourceMaterial"
},
{
"code" : "SubstanceSpecification"
},
{
"code" : "SupplyDelivery",
"param" : ["patient"]
},
{
"code" : "SupplyRequest",
"param" : ["subject"]
},
{
"code" : "Task"
},
{
"code" : "TerminologyCapabilities"
},
{
"code" : "TestReport"
},
{
"code" : "TestScript"
},
{
"code" : "ValueSet"
},
{
"code" : "VerificationResult"
},
{
"code" : "VisionPrescription",
"param" : ["patient"]
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/CompartmentDefinition/practitioner",
"resource" : {
"resourceType" : "CompartmentDefinition",
"id" : "practitioner",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "\r\nThe following resources may be in this compartment:\r\n
\r\n\r\n Resource Inclusion Criteria \r\n Account subject \r\n AdverseEvent recorder \r\n AllergyIntolerance recorder, asserter \r\n Appointment actor \r\n AppointmentResponse actor \r\n AuditEvent agent \r\n Basic author \r\n CarePlan performer \r\n CareTeam participant \r\n ChargeItem enterer, performer-actor \r\n Claim enterer, provider, payee, care-team \r\n ClaimResponse requestor \r\n ClinicalImpression assessor \r\n Communication sender, recipient \r\n CommunicationRequest sender, recipient, requester \r\n Composition subject, author, attester \r\n Condition asserter \r\n CoverageEligibilityRequest enterer, provider \r\n CoverageEligibilityResponse requestor \r\n DetectedIssue author \r\n DeviceRequest requester, performer \r\n DiagnosticReport performer \r\n DocumentManifest subject, author, recipient \r\n DocumentReference subject, author, authenticator \r\n Encounter practitioner, participant \r\n EpisodeOfCare care-manager \r\n ExplanationOfBenefit enterer, provider, payee, care-team \r\n Flag author \r\n Group member \r\n Immunization performer \r\n Invoice participant \r\n Linkage author \r\n List source \r\n Media subject, operator \r\n MedicationAdministration performer \r\n MedicationDispense performer, receiver \r\n MedicationRequest requester \r\n MedicationStatement source \r\n MessageHeader receiver, author, responsible, enterer \r\n NutritionOrder provider \r\n Observation performer \r\n Patient general-practitioner \r\n PaymentNotice provider \r\n PaymentReconciliation requestor \r\n Person practitioner \r\n Practitioner {def} \r\n PractitionerRole practitioner \r\n Procedure performer \r\n Provenance agent \r\n QuestionnaireResponse author, source \r\n RequestGroup participant, author \r\n ResearchStudy principalinvestigator \r\n RiskAssessment performer \r\n Schedule actor \r\n ServiceRequest performer, requester \r\n Specimen collector \r\n SupplyDelivery supplier, receiver \r\n SupplyRequest requester \r\n VisionPrescription prescriber \r\n
\r\n\r\nA resource is in this compartment if the nominated search parameter (or chain) refers to the patient resource that defines the compartment.\r\n
\r\n\r\n\r\n
\r\n\r\nThe following resources are never in this compartment:\r\n
\r\n\r\n - ActivityDefinition
\r\n - Binary
\r\n - BiologicallyDerivedProduct
\r\n - BodyStructure
\r\n - Bundle
\r\n - CapabilityStatement
\r\n - CatalogEntry
\r\n - ChargeItemDefinition
\r\n - CodeSystem
\r\n - CompartmentDefinition
\r\n - ConceptMap
\r\n - Consent
\r\n - Contract
\r\n - Coverage
\r\n - Device
\r\n - DeviceDefinition
\r\n - DeviceMetric
\r\n - DeviceUseStatement
\r\n - EffectEvidenceSynthesis
\r\n - Endpoint
\r\n - EnrollmentRequest
\r\n - EnrollmentResponse
\r\n - EventDefinition
\r\n - Evidence
\r\n - EvidenceVariable
\r\n - ExampleScenario
\r\n - FamilyMemberHistory
\r\n - Goal
\r\n - GraphDefinition
\r\n - GuidanceResponse
\r\n - HealthcareService
\r\n - ImagingStudy
\r\n - ImmunizationEvaluation
\r\n - ImmunizationRecommendation
\r\n - ImplementationGuide
\r\n - InsurancePlan
\r\n - Library
\r\n - Location
\r\n - Measure
\r\n - MeasureReport
\r\n - Medication
\r\n - MedicationKnowledge
\r\n - MedicinalProduct
\r\n - MedicinalProductAuthorization
\r\n - MedicinalProductContraindication
\r\n - MedicinalProductIndication
\r\n - MedicinalProductIngredient
\r\n - MedicinalProductInteraction
\r\n - MedicinalProductManufactured
\r\n - MedicinalProductPackaged
\r\n - MedicinalProductPharmaceutical
\r\n - MedicinalProductUndesirableEffect
\r\n - MessageDefinition
\r\n - MolecularSequence
\r\n - NamingSystem
\r\n - ObservationDefinition
\r\n - OperationDefinition
\r\n - OperationOutcome
\r\n - Organization
\r\n - OrganizationAffiliation
\r\n - PlanDefinition
\r\n - Questionnaire
\r\n - RelatedPerson
\r\n - ResearchDefinition
\r\n - ResearchElementDefinition
\r\n - ResearchSubject
\r\n - RiskEvidenceSynthesis
\r\n - SearchParameter
\r\n - Slot
\r\n - SpecimenDefinition
\r\n - StructureDefinition
\r\n - StructureMap
\r\n - Subscription
\r\n - Substance
\r\n - SubstanceNucleicAcid
\r\n - SubstancePolymer
\r\n - SubstanceProtein
\r\n - SubstanceReferenceInformation
\r\n - SubstanceSourceMaterial
\r\n - SubstanceSpecification
\r\n - Task
\r\n - TerminologyCapabilities
\r\n - TestReport
\r\n - TestScript
\r\n - ValueSet
\r\n - VerificationResult
\r\n
"
},
"url" : "http://hl7.org/fhir/CompartmentDefinition/practitioner",
"version" : "4.0.0",
"name" : "Base FHIR compartment definition for Practitioner",
"status" : "draft",
"experimental" : true,
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "FHIR Project Team",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
}],
"description" : "There is an instance of the practitioner compartment for each Practitioner resource, and the identity of the compartment is the same as the Practitioner. The set of resources associated with a particular practitioner",
"code" : "Practitioner",
"search" : true,
"resource" : [{
"code" : "Account",
"param" : ["subject"]
},
{
"code" : "ActivityDefinition"
},
{
"code" : "AdverseEvent",
"param" : ["recorder"]
},
{
"code" : "AllergyIntolerance",
"param" : ["recorder",
"asserter"]
},
{
"code" : "Appointment",
"param" : ["actor"]
},
{
"code" : "AppointmentResponse",
"param" : ["actor"]
},
{
"code" : "AuditEvent",
"param" : ["agent"]
},
{
"code" : "Basic",
"param" : ["author"]
},
{
"code" : "Binary"
},
{
"code" : "BiologicallyDerivedProduct"
},
{
"code" : "BodyStructure"
},
{
"code" : "Bundle"
},
{
"code" : "CapabilityStatement"
},
{
"code" : "CarePlan",
"param" : ["performer"]
},
{
"code" : "CareTeam",
"param" : ["participant"]
},
{
"code" : "CatalogEntry"
},
{
"code" : "ChargeItem",
"param" : ["enterer",
"performer-actor"]
},
{
"code" : "ChargeItemDefinition"
},
{
"code" : "Claim",
"param" : ["enterer",
"provider",
"payee",
"care-team"]
},
{
"code" : "ClaimResponse",
"param" : ["requestor"]
},
{
"code" : "ClinicalImpression",
"param" : ["assessor"]
},
{
"code" : "CodeSystem"
},
{
"code" : "Communication",
"param" : ["sender",
"recipient"]
},
{
"code" : "CommunicationRequest",
"param" : ["sender",
"recipient",
"requester"]
},
{
"code" : "CompartmentDefinition"
},
{
"code" : "Composition",
"param" : ["subject",
"author",
"attester"]
},
{
"code" : "ConceptMap"
},
{
"code" : "Condition",
"param" : ["asserter"]
},
{
"code" : "Consent"
},
{
"code" : "Contract"
},
{
"code" : "Coverage"
},
{
"code" : "CoverageEligibilityRequest",
"param" : ["enterer",
"provider"]
},
{
"code" : "CoverageEligibilityResponse",
"param" : ["requestor"]
},
{
"code" : "DetectedIssue",
"param" : ["author"]
},
{
"code" : "Device"
},
{
"code" : "DeviceDefinition"
},
{
"code" : "DeviceMetric"
},
{
"code" : "DeviceRequest",
"param" : ["requester",
"performer"]
},
{
"code" : "DeviceUseStatement"
},
{
"code" : "DiagnosticReport",
"param" : ["performer"]
},
{
"code" : "DocumentManifest",
"param" : ["subject",
"author",
"recipient"]
},
{
"code" : "DocumentReference",
"param" : ["subject",
"author",
"authenticator"]
},
{
"code" : "EffectEvidenceSynthesis"
},
{
"code" : "Encounter",
"param" : ["practitioner",
"participant"]
},
{
"code" : "Endpoint"
},
{
"code" : "EnrollmentRequest"
},
{
"code" : "EnrollmentResponse"
},
{
"code" : "EpisodeOfCare",
"param" : ["care-manager"]
},
{
"code" : "EventDefinition"
},
{
"code" : "Evidence"
},
{
"code" : "EvidenceVariable"
},
{
"code" : "ExampleScenario"
},
{
"code" : "ExplanationOfBenefit",
"param" : ["enterer",
"provider",
"payee",
"care-team"]
},
{
"code" : "FamilyMemberHistory"
},
{
"code" : "Flag",
"param" : ["author"]
},
{
"code" : "Goal"
},
{
"code" : "GraphDefinition"
},
{
"code" : "Group",
"param" : ["member"]
},
{
"code" : "GuidanceResponse"
},
{
"code" : "HealthcareService"
},
{
"code" : "ImagingStudy"
},
{
"code" : "Immunization",
"param" : ["performer"]
},
{
"code" : "ImmunizationEvaluation"
},
{
"code" : "ImmunizationRecommendation"
},
{
"code" : "ImplementationGuide"
},
{
"code" : "InsurancePlan"
},
{
"code" : "Invoice",
"param" : ["participant"]
},
{
"code" : "Library"
},
{
"code" : "Linkage",
"param" : ["author"]
},
{
"code" : "List",
"param" : ["source"]
},
{
"code" : "Location"
},
{
"code" : "Measure"
},
{
"code" : "MeasureReport"
},
{
"code" : "Media",
"param" : ["subject",
"operator"]
},
{
"code" : "Medication"
},
{
"code" : "MedicationAdministration",
"param" : ["performer"]
},
{
"code" : "MedicationDispense",
"param" : ["performer",
"receiver"]
},
{
"code" : "MedicationKnowledge"
},
{
"code" : "MedicationRequest",
"param" : ["requester"]
},
{
"code" : "MedicationStatement",
"param" : ["source"]
},
{
"code" : "MedicinalProduct"
},
{
"code" : "MedicinalProductAuthorization"
},
{
"code" : "MedicinalProductContraindication"
},
{
"code" : "MedicinalProductIndication"
},
{
"code" : "MedicinalProductIngredient"
},
{
"code" : "MedicinalProductInteraction"
},
{
"code" : "MedicinalProductManufactured"
},
{
"code" : "MedicinalProductPackaged"
},
{
"code" : "MedicinalProductPharmaceutical"
},
{
"code" : "MedicinalProductUndesirableEffect"
},
{
"code" : "MessageDefinition"
},
{
"code" : "MessageHeader",
"param" : ["receiver",
"author",
"responsible",
"enterer"]
},
{
"code" : "MolecularSequence"
},
{
"code" : "NamingSystem"
},
{
"code" : "NutritionOrder",
"param" : ["provider"]
},
{
"code" : "Observation",
"param" : ["performer"]
},
{
"code" : "ObservationDefinition"
},
{
"code" : "OperationDefinition"
},
{
"code" : "OperationOutcome"
},
{
"code" : "Organization"
},
{
"code" : "OrganizationAffiliation"
},
{
"code" : "Patient",
"param" : ["general-practitioner"]
},
{
"code" : "PaymentNotice",
"param" : ["provider"]
},
{
"code" : "PaymentReconciliation",
"param" : ["requestor"]
},
{
"code" : "Person",
"param" : ["practitioner"]
},
{
"code" : "PlanDefinition"
},
{
"code" : "Practitioner",
"param" : ["{def}"]
},
{
"code" : "PractitionerRole",
"param" : ["practitioner"]
},
{
"code" : "Procedure",
"param" : ["performer"]
},
{
"code" : "Provenance",
"param" : ["agent"]
},
{
"code" : "Questionnaire"
},
{
"code" : "QuestionnaireResponse",
"param" : ["author",
"source"]
},
{
"code" : "RelatedPerson"
},
{
"code" : "RequestGroup",
"param" : ["participant",
"author"]
},
{
"code" : "ResearchDefinition"
},
{
"code" : "ResearchElementDefinition"
},
{
"code" : "ResearchStudy",
"param" : ["principalinvestigator"]
},
{
"code" : "ResearchSubject"
},
{
"code" : "RiskAssessment",
"param" : ["performer"]
},
{
"code" : "RiskEvidenceSynthesis"
},
{
"code" : "Schedule",
"param" : ["actor"]
},
{
"code" : "SearchParameter"
},
{
"code" : "ServiceRequest",
"param" : ["performer",
"requester"]
},
{
"code" : "Slot"
},
{
"code" : "Specimen",
"param" : ["collector"]
},
{
"code" : "SpecimenDefinition"
},
{
"code" : "StructureDefinition"
},
{
"code" : "StructureMap"
},
{
"code" : "Subscription"
},
{
"code" : "Substance"
},
{
"code" : "SubstanceNucleicAcid"
},
{
"code" : "SubstancePolymer"
},
{
"code" : "SubstanceProtein"
},
{
"code" : "SubstanceReferenceInformation"
},
{
"code" : "SubstanceSourceMaterial"
},
{
"code" : "SubstanceSpecification"
},
{
"code" : "SupplyDelivery",
"param" : ["supplier",
"receiver"]
},
{
"code" : "SupplyRequest",
"param" : ["requester"]
},
{
"code" : "Task"
},
{
"code" : "TerminologyCapabilities"
},
{
"code" : "TestReport"
},
{
"code" : "TestScript"
},
{
"code" : "ValueSet"
},
{
"code" : "VerificationResult"
},
{
"code" : "VisionPrescription",
"param" : ["prescriber"]
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/CompartmentDefinition/relatedPerson",
"resource" : {
"resourceType" : "CompartmentDefinition",
"id" : "relatedPerson",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "\r\nThe following resources may be in this compartment:\r\n
\r\n\r\n Resource Inclusion Criteria \r\n AdverseEvent recorder \r\n AllergyIntolerance asserter \r\n Appointment actor \r\n AppointmentResponse actor \r\n Basic author \r\n CarePlan performer \r\n CareTeam participant \r\n ChargeItem enterer, performer-actor \r\n Claim payee \r\n Communication sender, recipient \r\n CommunicationRequest sender, recipient, requester \r\n Composition author \r\n Condition asserter \r\n Coverage policy-holder, subscriber, payor \r\n DocumentManifest author, recipient \r\n DocumentReference author \r\n Encounter participant \r\n ExplanationOfBenefit payee \r\n Invoice recipient \r\n MedicationAdministration performer \r\n MedicationStatement source \r\n Observation performer \r\n Patient link \r\n Person link \r\n Procedure performer \r\n Provenance agent \r\n QuestionnaireResponse author, source \r\n RelatedPerson {def} \r\n RequestGroup participant \r\n Schedule actor \r\n ServiceRequest performer \r\n SupplyRequest requester \r\n
\r\n\r\nA resource is in this compartment if the nominated search parameter (or chain) refers to the patient resource that defines the compartment.\r\n
\r\n\r\n\r\n
\r\n\r\nThe following resources are never in this compartment:\r\n
\r\n\r\n - Account
\r\n - ActivityDefinition
\r\n - AuditEvent
\r\n - Binary
\r\n - BiologicallyDerivedProduct
\r\n - BodyStructure
\r\n - Bundle
\r\n - CapabilityStatement
\r\n - CatalogEntry
\r\n - ChargeItemDefinition
\r\n - ClaimResponse
\r\n - ClinicalImpression
\r\n - CodeSystem
\r\n - CompartmentDefinition
\r\n - ConceptMap
\r\n - Consent
\r\n - Contract
\r\n - CoverageEligibilityRequest
\r\n - CoverageEligibilityResponse
\r\n - DetectedIssue
\r\n - Device
\r\n - DeviceDefinition
\r\n - DeviceMetric
\r\n - DeviceRequest
\r\n - DeviceUseStatement
\r\n - DiagnosticReport
\r\n - EffectEvidenceSynthesis
\r\n - Endpoint
\r\n - EnrollmentRequest
\r\n - EnrollmentResponse
\r\n - EpisodeOfCare
\r\n - EventDefinition
\r\n - Evidence
\r\n - EvidenceVariable
\r\n - ExampleScenario
\r\n - FamilyMemberHistory
\r\n - Flag
\r\n - Goal
\r\n - GraphDefinition
\r\n - Group
\r\n - GuidanceResponse
\r\n - HealthcareService
\r\n - ImagingStudy
\r\n - Immunization
\r\n - ImmunizationEvaluation
\r\n - ImmunizationRecommendation
\r\n - ImplementationGuide
\r\n - InsurancePlan
\r\n - Library
\r\n - Linkage
\r\n - List
\r\n - Location
\r\n - Measure
\r\n - MeasureReport
\r\n - Media
\r\n - Medication
\r\n - MedicationDispense
\r\n - MedicationKnowledge
\r\n - MedicationRequest
\r\n - MedicinalProduct
\r\n - MedicinalProductAuthorization
\r\n - MedicinalProductContraindication
\r\n - MedicinalProductIndication
\r\n - MedicinalProductIngredient
\r\n - MedicinalProductInteraction
\r\n - MedicinalProductManufactured
\r\n - MedicinalProductPackaged
\r\n - MedicinalProductPharmaceutical
\r\n - MedicinalProductUndesirableEffect
\r\n - MessageDefinition
\r\n - MessageHeader
\r\n - MolecularSequence
\r\n - NamingSystem
\r\n - NutritionOrder
\r\n - ObservationDefinition
\r\n - OperationDefinition
\r\n - OperationOutcome
\r\n - Organization
\r\n - OrganizationAffiliation
\r\n - PaymentNotice
\r\n - PaymentReconciliation
\r\n - PlanDefinition
\r\n - Practitioner
\r\n - PractitionerRole
\r\n - Questionnaire
\r\n - ResearchDefinition
\r\n - ResearchElementDefinition
\r\n - ResearchStudy
\r\n - ResearchSubject
\r\n - RiskAssessment
\r\n - RiskEvidenceSynthesis
\r\n - SearchParameter
\r\n - Slot
\r\n - Specimen
\r\n - SpecimenDefinition
\r\n - StructureDefinition
\r\n - StructureMap
\r\n - Subscription
\r\n - Substance
\r\n - SubstanceNucleicAcid
\r\n - SubstancePolymer
\r\n - SubstanceProtein
\r\n - SubstanceReferenceInformation
\r\n - SubstanceSourceMaterial
\r\n - SubstanceSpecification
\r\n - SupplyDelivery
\r\n - Task
\r\n - TerminologyCapabilities
\r\n - TestReport
\r\n - TestScript
\r\n - ValueSet
\r\n - VerificationResult
\r\n - VisionPrescription
\r\n
"
},
"url" : "http://hl7.org/fhir/CompartmentDefinition/relatedPerson",
"version" : "4.0.0",
"name" : "Base FHIR compartment definition for RelatedPerson",
"status" : "draft",
"experimental" : true,
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "FHIR Project Team",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
}],
"description" : "There is an instance of the relatedPerson compartment for each relatedPerson resource, and the identity of the compartment is the same as the relatedPerson. The set of resources associated with a particular 'related person'",
"code" : "RelatedPerson",
"search" : true,
"resource" : [{
"code" : "Account"
},
{
"code" : "ActivityDefinition"
},
{
"code" : "AdverseEvent",
"param" : ["recorder"]
},
{
"code" : "AllergyIntolerance",
"param" : ["asserter"]
},
{
"code" : "Appointment",
"param" : ["actor"]
},
{
"code" : "AppointmentResponse",
"param" : ["actor"]
},
{
"code" : "AuditEvent"
},
{
"code" : "Basic",
"param" : ["author"]
},
{
"code" : "Binary"
},
{
"code" : "BiologicallyDerivedProduct"
},
{
"code" : "BodyStructure"
},
{
"code" : "Bundle"
},
{
"code" : "CapabilityStatement"
},
{
"code" : "CarePlan",
"param" : ["performer"]
},
{
"code" : "CareTeam",
"param" : ["participant"]
},
{
"code" : "CatalogEntry"
},
{
"code" : "ChargeItem",
"param" : ["enterer",
"performer-actor"]
},
{
"code" : "ChargeItemDefinition"
},
{
"code" : "Claim",
"param" : ["payee"]
},
{
"code" : "ClaimResponse"
},
{
"code" : "ClinicalImpression"
},
{
"code" : "CodeSystem"
},
{
"code" : "Communication",
"param" : ["sender",
"recipient"]
},
{
"code" : "CommunicationRequest",
"param" : ["sender",
"recipient",
"requester"]
},
{
"code" : "CompartmentDefinition"
},
{
"code" : "Composition",
"param" : ["author"]
},
{
"code" : "ConceptMap"
},
{
"code" : "Condition",
"param" : ["asserter"]
},
{
"code" : "Consent"
},
{
"code" : "Contract"
},
{
"code" : "Coverage",
"param" : ["policy-holder",
"subscriber",
"payor"]
},
{
"code" : "CoverageEligibilityRequest"
},
{
"code" : "CoverageEligibilityResponse"
},
{
"code" : "DetectedIssue"
},
{
"code" : "Device"
},
{
"code" : "DeviceDefinition"
},
{
"code" : "DeviceMetric"
},
{
"code" : "DeviceRequest"
},
{
"code" : "DeviceUseStatement"
},
{
"code" : "DiagnosticReport"
},
{
"code" : "DocumentManifest",
"param" : ["author",
"recipient"]
},
{
"code" : "DocumentReference",
"param" : ["author"]
},
{
"code" : "EffectEvidenceSynthesis"
},
{
"code" : "Encounter",
"param" : ["participant"]
},
{
"code" : "Endpoint"
},
{
"code" : "EnrollmentRequest"
},
{
"code" : "EnrollmentResponse"
},
{
"code" : "EpisodeOfCare"
},
{
"code" : "EventDefinition"
},
{
"code" : "Evidence"
},
{
"code" : "EvidenceVariable"
},
{
"code" : "ExampleScenario"
},
{
"code" : "ExplanationOfBenefit",
"param" : ["payee"]
},
{
"code" : "FamilyMemberHistory"
},
{
"code" : "Flag"
},
{
"code" : "Goal"
},
{
"code" : "GraphDefinition"
},
{
"code" : "Group"
},
{
"code" : "GuidanceResponse"
},
{
"code" : "HealthcareService"
},
{
"code" : "ImagingStudy"
},
{
"code" : "Immunization"
},
{
"code" : "ImmunizationEvaluation"
},
{
"code" : "ImmunizationRecommendation"
},
{
"code" : "ImplementationGuide"
},
{
"code" : "InsurancePlan"
},
{
"code" : "Invoice",
"param" : ["recipient"]
},
{
"code" : "Library"
},
{
"code" : "Linkage"
},
{
"code" : "List"
},
{
"code" : "Location"
},
{
"code" : "Measure"
},
{
"code" : "MeasureReport"
},
{
"code" : "Media"
},
{
"code" : "Medication"
},
{
"code" : "MedicationAdministration",
"param" : ["performer"]
},
{
"code" : "MedicationDispense"
},
{
"code" : "MedicationKnowledge"
},
{
"code" : "MedicationRequest"
},
{
"code" : "MedicationStatement",
"param" : ["source"]
},
{
"code" : "MedicinalProduct"
},
{
"code" : "MedicinalProductAuthorization"
},
{
"code" : "MedicinalProductContraindication"
},
{
"code" : "MedicinalProductIndication"
},
{
"code" : "MedicinalProductIngredient"
},
{
"code" : "MedicinalProductInteraction"
},
{
"code" : "MedicinalProductManufactured"
},
{
"code" : "MedicinalProductPackaged"
},
{
"code" : "MedicinalProductPharmaceutical"
},
{
"code" : "MedicinalProductUndesirableEffect"
},
{
"code" : "MessageDefinition"
},
{
"code" : "MessageHeader"
},
{
"code" : "MolecularSequence"
},
{
"code" : "NamingSystem"
},
{
"code" : "NutritionOrder"
},
{
"code" : "Observation",
"param" : ["performer"]
},
{
"code" : "ObservationDefinition"
},
{
"code" : "OperationDefinition"
},
{
"code" : "OperationOutcome"
},
{
"code" : "Organization"
},
{
"code" : "OrganizationAffiliation"
},
{
"code" : "Patient",
"param" : ["link"]
},
{
"code" : "PaymentNotice"
},
{
"code" : "PaymentReconciliation"
},
{
"code" : "Person",
"param" : ["link"]
},
{
"code" : "PlanDefinition"
},
{
"code" : "Practitioner"
},
{
"code" : "PractitionerRole"
},
{
"code" : "Procedure",
"param" : ["performer"]
},
{
"code" : "Provenance",
"param" : ["agent"]
},
{
"code" : "Questionnaire"
},
{
"code" : "QuestionnaireResponse",
"param" : ["author",
"source"]
},
{
"code" : "RelatedPerson",
"param" : ["{def}"]
},
{
"code" : "RequestGroup",
"param" : ["participant"]
},
{
"code" : "ResearchDefinition"
},
{
"code" : "ResearchElementDefinition"
},
{
"code" : "ResearchStudy"
},
{
"code" : "ResearchSubject"
},
{
"code" : "RiskAssessment"
},
{
"code" : "RiskEvidenceSynthesis"
},
{
"code" : "Schedule",
"param" : ["actor"]
},
{
"code" : "SearchParameter"
},
{
"code" : "ServiceRequest",
"param" : ["performer"]
},
{
"code" : "Slot"
},
{
"code" : "Specimen"
},
{
"code" : "SpecimenDefinition"
},
{
"code" : "StructureDefinition"
},
{
"code" : "StructureMap"
},
{
"code" : "Subscription"
},
{
"code" : "Substance"
},
{
"code" : "SubstanceNucleicAcid"
},
{
"code" : "SubstancePolymer"
},
{
"code" : "SubstanceProtein"
},
{
"code" : "SubstanceReferenceInformation"
},
{
"code" : "SubstanceSourceMaterial"
},
{
"code" : "SubstanceSpecification"
},
{
"code" : "SupplyDelivery"
},
{
"code" : "SupplyRequest",
"param" : ["requester"]
},
{
"code" : "Task"
},
{
"code" : "TerminologyCapabilities"
},
{
"code" : "TestReport"
},
{
"code" : "TestScript"
},
{
"code" : "ValueSet"
},
{
"code" : "VerificationResult"
},
{
"code" : "VisionPrescription"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/ActivityDefinition-apply",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "ActivityDefinition-apply",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Apply
OPERATION: Apply
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/ActivityDefinition-apply
The apply operation applies a definition in a specific context
\nURL: [base]/ActivityDefinition/$apply
URL: [base]/ActivityDefinition/[id]/$apply
Parameters
Use Name Cardinality Type Binding Documentation IN activityDefinition 0..1 ActivityDefinition The activity definition to apply. If the operation is invoked on an instance, this parameter is not allowed. If the operation is invoked at the type level, this parameter is required
\nIN subject 1..* string
(reference) The subject(s) that is/are the target of the activity definition to be applied. The subject may be a Patient, Practitioner, Organization, Location, Device, or Group. Subjects provided in this parameter will be resolved as the subject of the PlanDefinition based on the type of the subject. If multiple subjects of the same type are provided, the behavior is implementation-defined
\nIN encounter 0..1 string
(reference) The encounter in context, if any
\nIN practitioner 0..1 string
(reference) The practitioner in context
\nIN organization 0..1 string
(reference) The organization in context
\nIN userType 0..1 CodeableConcept The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.)
\nIN userLanguage 0..1 CodeableConcept Preferred language of the person using the system
\nIN userTaskContext 0..1 CodeableConcept The task the system user is performing, e.g. laboratory results review, medication list review, etc. This information can be used to tailor decision support outputs, such as recommended information resources
\nIN setting 0..1 CodeableConcept The current setting of the request (inpatient, outpatient, etc.)
\nIN settingContext 0..1 CodeableConcept Additional detail about the setting of the request, if any
\nOUT return 1..1 Any The resource that is the result of applying the definition
\n
The result of invoking this operation is a resource of the type specified by the activity definition, with all the definitions resolved as appropriate for the type of resource. Any dynamicValue elements will be evaluated (in the order in which they appear in the resource) and the results applied to the returned resource. If the ActivityDefinition includes library references, those libraries will be available to the evaluated expressions. If those libraries have parameters, those parameters will be bound by name to the parameters given to the operation. In addition, parameters to the $apply operation are available within dynamicValue expressions as context variables, accessible by the name of the parameter, prefixed with a percent (%) symbol. For a more detailed description, refer to the ActivityDefinition resource
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/ActivityDefinition-apply",
"version" : "4.0.0",
"name" : "Apply",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "The apply operation applies a definition in a specific context",
"code" : "apply",
"comment" : "The result of invoking this operation is a resource of the type specified by the activity definition, with all the definitions resolved as appropriate for the type of resource. Any dynamicValue elements will be evaluated (in the order in which they appear in the resource) and the results applied to the returned resource. If the ActivityDefinition includes library references, those libraries will be available to the evaluated expressions. If those libraries have parameters, those parameters will be bound by name to the parameters given to the operation. In addition, parameters to the $apply operation are available within dynamicValue expressions as context variables, accessible by the name of the parameter, prefixed with a percent (%) symbol. For a more detailed description, refer to the ActivityDefinition resource",
"resource" : ["ActivityDefinition"],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [{
"name" : "activityDefinition",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The activity definition to apply. If the operation is invoked on an instance, this parameter is not allowed. If the operation is invoked at the type level, this parameter is required",
"type" : "ActivityDefinition"
},
{
"name" : "subject",
"use" : "in",
"min" : 1,
"max" : "*",
"documentation" : "The subject(s) that is/are the target of the activity definition to be applied. The subject may be a Patient, Practitioner, Organization, Location, Device, or Group. Subjects provided in this parameter will be resolved as the subject of the PlanDefinition based on the type of the subject. If multiple subjects of the same type are provided, the behavior is implementation-defined",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "encounter",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The encounter in context, if any",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "practitioner",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The practitioner in context",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "organization",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The organization in context",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "userType",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.)",
"type" : "CodeableConcept"
},
{
"name" : "userLanguage",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Preferred language of the person using the system",
"type" : "CodeableConcept"
},
{
"name" : "userTaskContext",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The task the system user is performing, e.g. laboratory results review, medication list review, etc. This information can be used to tailor decision support outputs, such as recommended information resources",
"type" : "CodeableConcept"
},
{
"name" : "setting",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The current setting of the request (inpatient, outpatient, etc.)",
"type" : "CodeableConcept"
},
{
"name" : "settingContext",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Additional detail about the setting of the request, if any",
"type" : "CodeableConcept"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The resource that is the result of applying the definition",
"type" : "Any"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/ActivityDefinition-data-requirements",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "ActivityDefinition-data-requirements",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Data Requirements
OPERATION: Data Requirements
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/ActivityDefinition-data-requirements
The data-requirements operation aggregates and returns the parameters and data requirements for the activity definition and all its dependencies as a single module definition library
\nURL: [base]/ActivityDefinition/[id]/$data-requirements
Parameters
Use Name Cardinality Type Binding Documentation OUT return 1..1 Library The result of the requirements gathering represented as a module-definition Library that describes the aggregate parameters, data requirements, and dependencies of the activity definition
\n
The effect of invoking this operation is to determine the aggregate set of data requirements and dependencies for the activity definition. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the activity definition and any libraries referenced by it. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements)
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/ActivityDefinition-data-requirements",
"version" : "4.0.0",
"name" : "Data Requirements",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "The data-requirements operation aggregates and returns the parameters and data requirements for the activity definition and all its dependencies as a single module definition library",
"code" : "data-requirements",
"comment" : "The effect of invoking this operation is to determine the aggregate set of data requirements and dependencies for the activity definition. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the activity definition and any libraries referenced by it. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements)",
"resource" : ["ActivityDefinition"],
"system" : false,
"type" : false,
"instance" : true,
"parameter" : [{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The result of the requirements gathering represented as a module-definition Library that describes the aggregate parameters, data requirements, and dependencies of the activity definition",
"type" : "Library"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/CapabilityStatement-conforms",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "CapabilityStatement-conforms",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Test if a server implements a client's required operations
OPERATION: Test if a server implements a client's required operations
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/CapabilityStatement-conforms
This operation asks the server to check that it implements all the resources, interactions, search parameters, and operations that the client provides in its capability statement. The client provides both capability statements by reference, and must ensure that all the referenced resources are available to the conformance server
\nURL: [base]/CapabilityStatement/$conforms
Parameters
Use Name Cardinality Type Binding Documentation IN left 0..1 canonical A canonical reference to the left-hand system's capability statement
\nIN right 0..1 canonical A canonical reference to the right-hand system's capability statement
\nIN mode 0..1 code What kind of comparison to perform - server to server, or client to server (use the codes 'server/server' or 'client/server')
\nOUT issues 1..1 OperationOutcome Outcome of the CapabilityStatement test
\nOUT union 0..1 CapabilityStatement The intersection of the functionality described by the CapabilityStatement resources
\nOUT intersection 0..1 CapabilityStatement The union of the functionality described by the CapabilityStatement resources
\n
The operation performs a full comparison of the functionality described by the two capability statements, including the profiles and value sets they reference, and also including concept maps and structure maps.
\nThe full execution of this operation is still a matter of research, but it is intended to support comparison of systems to see if they will interoperate
\nIf the capability statements can be successfully compared, then the return value is a 200 OK with an OperationOutcome along with intersection and union capability statements. The operation outcome can contain errors relating to differences between the capability statements. If the capability statements cannot be compared, because dependencies cannot be located, the return value is a 4xx error, with an OperationOutcome with at least one issue with severity >= error
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/CapabilityStatement-conforms",
"version" : "4.0.0",
"name" : "Test if a server implements a client's required operations",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "This operation asks the server to check that it implements all the resources, interactions, search parameters, and operations that the client provides in its capability statement. The client provides both capability statements by reference, and must ensure that all the referenced resources are available to the conformance server",
"code" : "conforms",
"comment" : "The operation performs a full comparison of the functionality described by the two capability statements, including the profiles and value sets they reference, and also including concept maps and structure maps. \n\nThe full execution of this operation is still a matter of research, but it is intended to support comparison of systems to see if they will interoperate \n\nIf the capability statements can be successfully compared, then the return value is a 200 OK with an OperationOutcome along with intersection and union capability statements. The operation outcome can contain errors relating to differences between the capability statements. If the capability statements cannot be compared, because dependencies cannot be located, the return value is a 4xx error, with an OperationOutcome with at least one issue with severity >= error",
"resource" : ["CapabilityStatement"],
"system" : false,
"type" : true,
"instance" : false,
"parameter" : [{
"name" : "left",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A canonical reference to the left-hand system's capability statement",
"type" : "canonical"
},
{
"name" : "right",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A canonical reference to the right-hand system's capability statement",
"type" : "canonical"
},
{
"name" : "mode",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "What kind of comparison to perform - server to server, or client to server (use the codes 'server/server' or 'client/server')",
"type" : "code"
},
{
"name" : "issues",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Outcome of the CapabilityStatement test",
"type" : "OperationOutcome"
},
{
"name" : "union",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "The intersection of the functionality described by the CapabilityStatement resources",
"type" : "CapabilityStatement"
},
{
"name" : "intersection",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "The union of the functionality described by the CapabilityStatement resources",
"type" : "CapabilityStatement"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/CapabilityStatement-implements",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "CapabilityStatement-implements",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Test if a server implements a client's required operations
OPERATION: Test if a server implements a client's required operations
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/CapabilityStatement-implements
This operation asks the server to check that it implements all the resources, interactions, search parameters, and operations that the client provides in its capability statement. The client provides its capability statement inline, or by referring the server to the canonical URL of its capability statement
\nURL: [base]/CapabilityStatement/$implements
URL: [base]/CapabilityStatement/[id]/$implements
Parameters
Use Name Cardinality Type Binding Documentation IN server 0..1 canonical A canonical reference to the server capability statement - use this if the implements is not invoked on an instance (or on the /metadata end-point)
\nIN client 0..1 canonical A canonical reference to the client capability statement - use this if the implements is not invoked on an instance (or on the /metadata end-point)
\nIN resource 0..1 CapabilityStatement The client capability statement, provided inline
\nOUT return 1..1 OperationOutcome Outcome of the CapabilityStatement test
\n
The operation does not perform a full conformance check; in particular it does not check that the profiles align. It merely checks that the behaviors the client wishes to use are provided Technically, this operation is implemented as follows:
\n\n- The server's capability statement must have an entry for each resource in the client's capability statement
\n- The server's resource support must have matching flags for updateCreate, conditionalCreate, conditionalRead, conditionalUpdate, conditionalDelete, searchInclude, searchRevInclude
\n- The server's capability statement must have a matching interaction for each interaction in the client capability statement (whether or not it is on a resource)
\n- The server's capability statement must have a search parameter with matching name and definition for any search parameters in the client capability statement
\n- The server must have an operation definition with a matching reference for any operations in the client capability statement
\n
\nIf the capability statements match by these rules, then the return value is a 200 OK with an operation outcome that contains no issues with severity >= error. If the capability statement doesn't match, the return value is a 4xx error, with an OperationOutcome with at least one issue with severity >= error
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/CapabilityStatement-implements",
"version" : "4.0.0",
"name" : "Test if a server implements a client's required operations",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "This operation asks the server to check that it implements all the resources, interactions, search parameters, and operations that the client provides in its capability statement. The client provides its capability statement inline, or by referring the server to the canonical URL of its capability statement",
"code" : "implements",
"comment" : "The operation does not perform a full conformance check; in particular it does not check that the profiles align. It merely checks that the behaviors the client wishes to use are provided Technically, this operation is implemented as follows: \n\n* The server's capability statement must have an entry for each resource in the client's capability statement \n* The server's resource support must have matching flags for updateCreate, conditionalCreate, conditionalRead, conditionalUpdate, conditionalDelete, searchInclude, searchRevInclude \n* The server's capability statement must have a matching interaction for each interaction in the client capability statement (whether or not it is on a resource) \n* The server's capability statement must have a search parameter with matching name and definition for any search parameters in the client capability statement \n* The server must have an operation definition with a matching reference for any operations in the client capability statement \n\nIf the capability statements match by these rules, then the return value is a 200 OK with an operation outcome that contains no issues with severity >= error. If the capability statement doesn't match, the return value is a 4xx error, with an OperationOutcome with at least one issue with severity >= error",
"resource" : ["CapabilityStatement"],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [{
"name" : "server",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A canonical reference to the server capability statement - use this if the implements is not invoked on an instance (or on the /metadata end-point)",
"type" : "canonical"
},
{
"name" : "client",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A canonical reference to the client capability statement - use this if the implements is not invoked on an instance (or on the /metadata end-point)",
"type" : "canonical"
},
{
"name" : "resource",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The client capability statement, provided inline",
"type" : "CapabilityStatement"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Outcome of the CapabilityStatement test",
"type" : "OperationOutcome"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/CapabilityStatement-subset",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "CapabilityStatement-subset",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Fetch a subset of the CapabilityStatement resource
OPERATION: Fetch a subset of the CapabilityStatement resource
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/CapabilityStatement-subset
This operation asks the server to return a subset of the CapabilityStatement resource - just the REST parts that relate to a set of nominated resources - the resources that the client is interested in
\nURL: [base]/CapabilityStatement/$subset
URL: [base]/CapabilityStatement/[id]/$subset
Parameters
Use Name Cardinality Type Binding Documentation IN server 0..1 uri The canonical URL - use this if the subset is not invoked on an instance (or on the /metadata end-point)
\nIN resource 1..* code A resource that the client would like to include in the return
\nOUT return 1..1 CapabilityStatement The subsetted CapabilityStatement resource that is returned. This should be tagged with the SUBSETTED code
\n
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/CapabilityStatement-subset",
"version" : "4.0.0",
"name" : "Fetch a subset of the CapabilityStatement resource",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "This operation asks the server to return a subset of the CapabilityStatement resource - just the REST parts that relate to a set of nominated resources - the resources that the client is interested in",
"code" : "subset",
"resource" : ["CapabilityStatement"],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [{
"name" : "server",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The canonical URL - use this if the subset is not invoked on an instance (or on the /metadata end-point)",
"type" : "uri"
},
{
"name" : "resource",
"use" : "in",
"min" : 1,
"max" : "*",
"documentation" : "A resource that the client would like to include in the return",
"type" : "code"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The subsetted CapabilityStatement resource that is returned. This should be tagged with the SUBSETTED code",
"type" : "CapabilityStatement"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/CapabilityStatement-versions",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "CapabilityStatement-versions",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Discover what versions a server supports
OPERATION: Discover what versions a server supports
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/CapabilityStatement-versions
Using the FHIR Version Mime Type Parameter, a server can support multiple versions on the same end-point. The only way for client to find out what versions a server supports in this fashion is the $versions operation. The client invokes the operation with no parameters. and the server returns the list of supported versions, along with the default version it will use if no fhirVersion parameter is present
\nURL: [base]/$versions
Parameters
Use Name Cardinality Type Binding Documentation OUT version 1..* code A version supported by the server. Use the major.minor version like 3.0
\nOUT default 1..1 code The default version for the server. Use the major.minor version like 3.0
\n
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/CapabilityStatement-versions",
"version" : "4.0.0",
"name" : "Discover what versions a server supports",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "Using the [FHIR Version Mime Type Parameter](http.html#version-parameter), a server can support [multiple versions on the same end-point](versioning.html#mt-version). The only way for client to find out what versions a server supports in this fashion is the $versions operation. The client invokes the operation with no parameters. and the server returns the list of supported versions, along with the default version it will use if no fhirVersion parameter is present",
"code" : "versions",
"resource" : ["CapabilityStatement"],
"system" : true,
"type" : false,
"instance" : false,
"parameter" : [{
"name" : "version",
"use" : "out",
"min" : 1,
"max" : "*",
"documentation" : "A version supported by the server. Use the major.minor version like 3.0",
"type" : "code"
},
{
"name" : "default",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The default version for the server. Use the major.minor version like 3.0",
"type" : "code"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/ChargeItemDefinition-apply",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "ChargeItemDefinition-apply",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Apply
OPERATION: Apply
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/ChargeItemDefinition-apply
The apply operation applies a definition in a specific context
\nURL: [base]/ChargeItemDefinition/[id]/$apply
Parameters
Use Name Cardinality Type Binding Documentation IN chargeItem 1..1 Reference The ChargeItem on which the definition is to ba applies
\nIN account 0..1 Reference The account in context, if any
\nOUT return 1..1 Any The resource that is the result of applying the definition
\n
The result of invoking this operation is a resource of the type specified by the activity definition, with all the definitions resolved as appropriate for the type of resource. Any dynamicValue elements will be evaluated (in the order in which they appear in the resource) and the results applied to the returned resource. If the ActivityDefinition includes library references, those libraries will be available to the evaluated expressions. If those libraries have parameters, those parameters will be bound by name to the parameters given to the operation. For a more detailed description, refer to the ActivityDefinition resource
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/ChargeItemDefinition-apply",
"version" : "4.0.0",
"name" : "Apply",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "The apply operation applies a definition in a specific context",
"code" : "apply",
"comment" : "The result of invoking this operation is a resource of the type specified by the activity definition, with all the definitions resolved as appropriate for the type of resource. Any dynamicValue elements will be evaluated (in the order in which they appear in the resource) and the results applied to the returned resource. If the ActivityDefinition includes library references, those libraries will be available to the evaluated expressions. If those libraries have parameters, those parameters will be bound by name to the parameters given to the operation. For a more detailed description, refer to the ActivityDefinition resource",
"resource" : ["ChargeItemDefinition"],
"system" : false,
"type" : false,
"instance" : true,
"parameter" : [{
"name" : "chargeItem",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The ChargeItem on which the definition is to ba applies",
"type" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ChargeItem"]
},
{
"name" : "account",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The account in context, if any",
"type" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Account"]
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The resource that is the result of applying the definition",
"type" : "Any"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/Claim-submit",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "Claim-submit",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Submit a Claim resource for adjudication
OPERATION: Submit a Claim resource for adjudication
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Claim-submit
This operation is used to submit a Claim, Pre-Authorization or Pre-Determination (all instances of Claim resources) for adjudication either as a single Claim resource instance or as a Bundle containing the Claim and other referenced resources, or Bundle containing a batch of Claim resources, either as single Claims resources or Bundle resources, for processing. The only input parameter is the single Claim or Bundle resource and the only output is a single ClaimResponse, Bundle of ClaimResponses or an OperationOutcome resource.
\nURL: [base]/Claim/$submit
Parameters
Use Name Cardinality Type Binding Documentation IN resource 1..1 Resource A Claim resource or Bundle of claims, either as individual Claim resources or as Bundles each containing a single Claim plus referenced resources.
\nOUT return 1..1 Resource A ClaimResponse resource or Bundle of claim responses, either as individual ClaimResponse resources or as Bundles each containing a single ClaimResponse plus referenced resources.
\n
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/Claim-submit",
"version" : "4.0.0",
"name" : "Submit a Claim resource for adjudication",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "This operation is used to submit a Claim, Pre-Authorization or Pre-Determination (all instances of Claim resources) for adjudication either as a single Claim resource instance or as a Bundle containing the Claim and other referenced resources, or Bundle containing a batch of Claim resources, either as single Claims resources or Bundle resources, for processing. The only input parameter is the single Claim or Bundle resource and the only output is a single ClaimResponse, Bundle of ClaimResponses or an OperationOutcome resource.",
"code" : "submit",
"resource" : ["Claim"],
"system" : false,
"type" : true,
"instance" : false,
"parameter" : [{
"name" : "resource",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "A Claim resource or Bundle of claims, either as individual Claim resources or as Bundles each containing a single Claim plus referenced resources.",
"type" : "Resource"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "A ClaimResponse resource or Bundle of claim responses, either as individual ClaimResponse resources or as Bundles each containing a single ClaimResponse plus referenced resources.",
"type" : "Resource"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/CodeSystem-find-matches",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "CodeSystem-find-matches",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Finding codes based on supplied properties
OPERATION: Finding codes based on supplied properties
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/CodeSystem-find-matches
Given a set of properties (and text), return one or more possible matching codes
\nThis operation takes a set of properties, and examines the code system looking for codes in the code system that match a set of known properties.
\nWhen looking for matches, there are 3 possible types of match:
\n\n- a complete match - a code that represents all the provided properties correctly
\n- a partial match - a code that represents some of the provided properties correctly, and not others
\n- a possible match - a code that may represent the provided properties closely, but may capture less or more precise information for some of the properties
\n
\nThe $find-matches operation can be called in one of 2 modes:
\n\n- By a human, looking for the best match for a set of properties. In this mode, the server returns a list of complete, possible or partial matches (possibly with comments), so that the user can choose (or not) the most appropriate code
\n- By a machine (typically in a system interface performing a transformation). In this mode, the server returns only a list of complete and partial matches, but no possible matches. The machine can choose a code from the list (or not) based on what properties are not coded
\n
\nThese modes are differentiated by the 'exact' parameter, so the client can indicate whether it only wants exact matches (including partial matches) or whether potential matches based on text matching are desired
\nThe find-matches operation is still preliminary. The interface can be expected to change as more experience is gained from implementations.
\nURL: [base]/CodeSystem/$find-matches
URL: [base]/CodeSystem/[id]/$find-matches
Parameters
Use Name Cardinality Type Binding Documentation IN system 0..1 uri The system in which composition is to be performed. This must be provided unless the operation is invoked on a code system instance
\nIN version 0..1 string The version of the system for the inferencing to be performed
\nIN property 0..* One or more properties that contain information to be composed into the code
\nIN property.code 1..1 code Identifies the property provided
\nIN property.value 0..1 code The value of the property provided
\nIN property.subproperty 0..* Nested Properties (mainly used for SNOMED CT composition, for relationship Groups)
\nIN property.subproperty.code 1..1 code Identifies the sub-property provided
\nIN property.subproperty.value 1..1 code The value of the sub-property provided
\nIN exact 1..1 boolean Whether the operation is being used by a human ('false'), or a machine ('true'). If the operation is being used by a human, the terminology server can return a list of possible matches, with commentary. For a machine, the server returns complete or partial matches, not possible matches. The default value is 'false'
\nIN compositional 0..1 boolean Post-coordinated expressions are allowed to be returned in the matching codes (mainly for SNOMED CT). Default = false
\nOUT match 0..* Concepts returned by the server as a result of the inferencing operation
\nOUT match.code 1..1 Coding A code that matches the properties provided
\nOUT match.unmatched 0..* One or more properties that contain properties that could not be matched into the code
\nOUT match.unmatched.code 1..1 code Identifies the property provided
\nOUT match.unmatched.value 1..1 code The value of the property provided
\nOUT match.unmatched.property 0..* Nested Properties (mainly used for SNOMED CT composition, for relationship Groups)
\nOUT match.unmatched.property.code 1..1 code Identifies the sub-property provided
\nOUT match.unmatched.property.value 1..1 code The value of the sub-property provided
\nOUT match.comment 0..1 string Information about the quality of the match, if operation is for a human
\n
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/CodeSystem-find-matches",
"version" : "4.0.0",
"name" : "Finding codes based on supplied properties",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "Given a set of properties (and text), return one or more possible matching codes\n\nThis operation takes a set of properties, and examines the code system looking for codes in the code system that match a set of known properties. \n\nWhen looking for matches, there are 3 possible types of match:\n* a complete match - a code that represents all the provided properties correctly\n* a partial match - a code that represents some of the provided properties correctly, and not others \n* a possible match - a code that may represent the provided properties closely, but may capture less or more precise information for some of the properties\n\nThe $find-matches operation can be called in one of 2 modes:\n* By a human, looking for the best match for a set of properties. In this mode, the server returns a list of complete, possible or partial matches (possibly with comments), so that the user can choose (or not) the most appropriate code\n* By a machine (typically in a system interface performing a transformation). In this mode, the server returns only a list of complete and partial matches, but no possible matches. The machine can choose a code from the list (or not) based on what properties are not coded\n\nThese modes are differentiated by the 'exact' parameter, so the client can indicate whether it only wants exact matches (including partial matches) or whether potential matches based on text matching are desired\n \nThe find-matches operation is still preliminary. The interface can be expected to change as more experience is gained from implementations.",
"code" : "find-matches",
"resource" : ["CodeSystem"],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [{
"name" : "system",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The system in which composition is to be performed. This must be provided unless the operation is invoked on a code system instance",
"type" : "uri"
},
{
"name" : "version",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The version of the system for the inferencing to be performed",
"type" : "string"
},
{
"name" : "property",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "One or more properties that contain information to be composed into the code",
"part" : [{
"name" : "code",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Identifies the property provided",
"type" : "code"
},
{
"name" : "value",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The value of the property provided",
"type" : "code"
},
{
"name" : "subproperty",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Nested Properties (mainly used for SNOMED CT composition, for relationship Groups)",
"part" : [{
"name" : "code",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Identifies the sub-property provided",
"type" : "code"
},
{
"name" : "value",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The value of the sub-property provided",
"type" : "code"
}]
}]
},
{
"name" : "exact",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Whether the operation is being used by a human ('false'), or a machine ('true'). If the operation is being used by a human, the terminology server can return a list of possible matches, with commentary. For a machine, the server returns complete or partial matches, not possible matches. The default value is 'false'",
"type" : "boolean"
},
{
"name" : "compositional",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Post-coordinated expressions are allowed to be returned in the matching codes (mainly for SNOMED CT). Default = false",
"type" : "boolean"
},
{
"name" : "match",
"use" : "out",
"min" : 0,
"max" : "*",
"documentation" : "Concepts returned by the server as a result of the inferencing operation",
"part" : [{
"name" : "code",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "A code that matches the properties provided",
"type" : "Coding"
},
{
"name" : "unmatched",
"use" : "out",
"min" : 0,
"max" : "*",
"documentation" : "One or more properties that contain properties that could not be matched into the code",
"part" : [{
"name" : "code",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Identifies the property provided",
"type" : "code"
},
{
"name" : "value",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The value of the property provided",
"type" : "code"
},
{
"name" : "property",
"use" : "out",
"min" : 0,
"max" : "*",
"documentation" : "Nested Properties (mainly used for SNOMED CT composition, for relationship Groups)",
"part" : [{
"name" : "code",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Identifies the sub-property provided",
"type" : "code"
},
{
"name" : "value",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The value of the sub-property provided",
"type" : "code"
}]
}]
},
{
"name" : "comment",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "Information about the quality of the match, if operation is for a human",
"type" : "string"
}]
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/CodeSystem-lookup",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "CodeSystem-lookup",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Concept Look Up & Decomposition
OPERATION: Concept Look Up & Decomposition
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/CodeSystem-lookup
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.
\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
\nURL: [base]/CodeSystem/$lookup
Parameters
Use Name Cardinality Type Binding Documentation IN code 0..1 code The code that is to be located. If a code is provided, a system must be provided
\nIN system 0..1 uri The system for the code that is to be located
\nIN version 0..1 string The version of the system, if one was provided in the source data
\nIN coding 0..1 Coding A coding to look up
\nIN date 0..1 dateTime The date for which the information should be returned. Normally, this is the current conditions (which is the default value) but under some circumstances, systems need to acccess this information as it would have been in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy.
\nIN displayLanguage 0..1 code The requested language for display (see $expand.displayLanguage)
\nIN property 0..* code A property that the client wishes to be returned in the output. If no properties are specified, the server chooses what to return. The following properties are defined for all code systems: url, name, version (code system info) and code information: display, definition, designation, parent and child, and for designations, lang.X where X is a designation language code. Some of the properties are returned explicit in named parameters (when the names match), and the rest (except for lang.X) in the property parameter group
\nOUT name 1..1 string A display name for the code system
\nOUT version 0..1 string The version that these details are based on
\nOUT display 1..1 string The preferred display for this concept
\nOUT designation 0..* Additional representations for this concept
\nOUT designation.language 0..1 code The language this designation is defined for
\nOUT designation.use 0..1 Coding A code that details how this designation would be used
\nOUT designation.value 1..1 string The text value for this designation
\nOUT property 0..* One or more properties that contain additional information about the code, including status. For complex terminologies (e.g. SNOMED CT, LOINC, medications), these properties serve to decompose the code
\nOUT property.code 1..1 code Identifies the property returned
\nOUT property.value 0..1 code The value of the property returned
\nOUT property.description 0..1 string Human Readable representation of the property value (e.g. display for a code)
\nOUT property.subproperty 0..* Nested Properties (mainly used for SNOMED CT decomposition, for relationship Groups)
\nOUT property.subproperty.code 1..1 code Identifies the sub-property returned
\nOUT property.subproperty.value 1..1 code The value of the sub-property returned
\nOUT property.subproperty.description 0..1 string Human Readable representation of the property value (e.g. display for a code)
\n
Note that the $lookup operation is more than just a code system search - the server finds the concept, and gathers the return information from the underlying code system definitions.
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/CodeSystem-lookup",
"version" : "4.0.0",
"name" : "Concept Look Up & Decomposition",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "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",
"code" : "lookup",
"comment" : "Note that the $lookup operation is more than just a code system search - the server finds the concept, and gathers the return information from the underlying code system definitions.",
"resource" : ["CodeSystem"],
"system" : false,
"type" : true,
"instance" : false,
"parameter" : [{
"name" : "code",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The code that is to be located. If a code is provided, a system must be provided",
"type" : "code"
},
{
"name" : "system",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The system for the code that is to be located",
"type" : "uri"
},
{
"name" : "version",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The version of the system, if one was provided in the source data",
"type" : "string"
},
{
"name" : "coding",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A coding to look up",
"type" : "Coding"
},
{
"name" : "date",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The date for which the information should be returned. Normally, this is the current conditions (which is the default value) but under some circumstances, systems need to acccess this information as it would have been in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy.",
"type" : "dateTime"
},
{
"name" : "displayLanguage",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The requested language for display (see $expand.displayLanguage)",
"type" : "code"
},
{
"name" : "property",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "A property that the client wishes to be returned in the output. If no properties are specified, the server chooses what to return. The following properties are defined for all code systems: url, name, version (code system info) and code information: display, definition, designation, parent and child, and for designations, lang.X where X is a designation language code. Some of the properties are returned explicit in named parameters (when the names match), and the rest (except for lang.X) in the property parameter group",
"type" : "code"
},
{
"name" : "name",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "A display name for the code system",
"type" : "string"
},
{
"name" : "version",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "The version that these details are based on",
"type" : "string"
},
{
"name" : "display",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The preferred display for this concept",
"type" : "string"
},
{
"name" : "designation",
"use" : "out",
"min" : 0,
"max" : "*",
"documentation" : "Additional representations for this concept",
"part" : [{
"name" : "language",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "The language this designation is defined for",
"type" : "code"
},
{
"name" : "use",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "A code that details how this designation would be used",
"type" : "Coding"
},
{
"name" : "value",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The text value for this designation",
"type" : "string"
}]
},
{
"name" : "property",
"use" : "out",
"min" : 0,
"max" : "*",
"documentation" : "One or more properties that contain additional information about the code, including status. For complex terminologies (e.g. SNOMED CT, LOINC, medications), these properties serve to decompose the code",
"part" : [{
"name" : "code",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Identifies the property returned",
"type" : "code"
},
{
"name" : "value",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "The value of the property returned",
"type" : "code"
},
{
"name" : "description",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "Human Readable representation of the property value (e.g. display for a code)",
"type" : "string"
},
{
"name" : "subproperty",
"use" : "out",
"min" : 0,
"max" : "*",
"documentation" : "Nested Properties (mainly used for SNOMED CT decomposition, for relationship Groups)",
"part" : [{
"name" : "code",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Identifies the sub-property returned",
"type" : "code"
},
{
"name" : "value",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The value of the sub-property returned",
"type" : "code"
},
{
"name" : "description",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "Human Readable representation of the property value (e.g. display for a code)",
"type" : "string"
}]
}]
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/CodeSystem-subsumes",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "CodeSystem-subsumes",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Subsumption Testing
OPERATION: Subsumption Testing
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/CodeSystem-subsumes
Test the subsumption relationship between code/Coding A and code/Coding B given the semantics of subsumption in the underlying code system (see hierarchyMeaning).
\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
\nURL: [base]/CodeSystem/$subsumes
URL: [base]/CodeSystem/[id]/$subsumes
Parameters
Use Name Cardinality Type Binding Documentation IN codeA 0..1 code The "A" code that is to be tested. If a code is provided, a system must be provided
\nIN codeB 0..1 code The "B" code that is to be tested. If a code is provided, a system must be provided
\nIN system 0..1 uri The code system in which subsumption testing is to be performed. This must be provided unless the operation is invoked on a code system instance
\nIN version 0..1 string The version of the code system, if one was provided in the source data
\nIN codingA 0..1 Coding The "A" Coding that is to be tested. The code system does not have to match the specified subsumption code system, but the relationships between the code systems must be well established
\nIN codingB 0..1 Coding The "B" Coding that is to be tested. The code system does not have to match the specified subsumption code system, but the relationships between the code systems must be well established
\nOUT outcome 1..1 code http://hl7.org/fhir/ValueSet/concept-subsumption-outcome|4.0.0 (Required) The subsumption relationship between code/Coding "A" and code/Coding "B". There are 4 possible codes to be returned (equivalent, subsumes, subsumed-by, and not-subsumed) as defined in the concept-subsumption-outcome value set. If the server is unable to determine the relationship between the codes/Codings, then it returns an error response with an OperationOutcome.
\n
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/CodeSystem-subsumes",
"version" : "4.0.0",
"name" : "Subsumption Testing",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "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",
"code" : "subsumes",
"resource" : ["CodeSystem"],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [{
"name" : "codeA",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The \"A\" code that is to be tested. If a code is provided, a system must be provided",
"type" : "code"
},
{
"name" : "codeB",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The \"B\" code that is to be tested. If a code is provided, a system must be provided",
"type" : "code"
},
{
"name" : "system",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The code system in which subsumption testing is to be performed. This must be provided unless the operation is invoked on a code system instance",
"type" : "uri"
},
{
"name" : "version",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The version of the code system, if one was provided in the source data",
"type" : "string"
},
{
"name" : "codingA",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The \"A\" Coding that is to be tested. The code system does not have to match the specified subsumption code system, but the relationships between the code systems must be well established",
"type" : "Coding"
},
{
"name" : "codingB",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The \"B\" Coding that is to be tested. The code system does not have to match the specified subsumption code system, but the relationships between the code systems must be well established",
"type" : "Coding"
},
{
"name" : "outcome",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The subsumption relationship between code/Coding \"A\" and code/Coding \"B\". There are 4 possible codes to be returned (equivalent, subsumes, subsumed-by, and not-subsumed) as defined in the concept-subsumption-outcome value set. If the server is unable to determine the relationship between the codes/Codings, then it returns an error response with an OperationOutcome.",
"type" : "code",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/fhir/ValueSet/concept-subsumption-outcome|4.0.0"
}
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/CodeSystem-validate-code",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "CodeSystem-validate-code",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Code System based Validation
OPERATION: Code System based Validation
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/CodeSystem-validate-code
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.
\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
\nURL: [base]/CodeSystem/$validate-code
URL: [base]/CodeSystem/[id]/$validate-code
Parameters
Use Name Cardinality Type Binding Documentation IN url 0..1 uri CodeSystem URL. The server must know the code system (e.g. it is defined explicitly in the server'scode systems, or it is known implicitly by the server
\nIN codeSystem 0..1 CodeSystem The codeSystem is provided directly as part of the request. Servers may choose not to accept code systems in this fashion. This parameter is used when the client wants the server to check against a code system that is not stored on the server
\nIN code 0..1 code The code that is to be validated
\nIN version 0..1 string The version of the code system, if one was provided in the source data
\nIN display 0..1 string The display associated with the code, if provided. If a display is provided a code must be provided. If no display is provided, the server cannot validate the display value, but may choose to return a recommended display name in an extension in the outcome. Whether displays are case sensitive is code system dependent
\nIN coding 0..1 Coding A coding to validate. The system must match the specified code system
\nIN codeableConcept 0..1 CodeableConcept A full codeableConcept to validate. The server returns true if one of the coding values is in the code system, and may also validate that the codings are not in conflict with each other if more than one is present
\nIN date 0..1 dateTime The date for which the validation should be checked. Normally, this is the current conditions (which is the default values) but under some circumstances, systems need to validate that a correct code was used at some point in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy.
\nIN abstract 0..1 boolean If this parameter has a value of true, the client is stating that the validation is being performed in a context where a concept designated as 'abstract' is appropriate/allowed to be used, and the server should regard abstract codes as valid. If this parameter is false, abstract codes are not considered to be valid.
\nNote that. 'abstract' is a property defined by many HL7 code systems that indicates that the concept is a logical grouping concept that is not intended to be used asa 'concrete' concept to in an actual patient/care/process record. This language is borrowed from Object Orienated theory where 'asbtract' objects are never instantiated. However in the general record and terminology eco-system, there are many contexts where it is appropraite to use these codes e.g. as decision making criterion, or when editing value sets themselves. This parameter allows a client to indicate to the server that it is working in such a context.
\nIN displayLanguage 0..1 code Specifies the language to be used for description when validating the display property
\nOUT result 1..1 boolean True if the concept details supplied are valid
\nOUT message 0..1 string Error details, if result = false. If this is provided when result = true, the message carries hints and warnings
\nOUT display 0..1 string A valid display for the concept if the system wishes to display this to a user
\n
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/CodeSystem-validate-code",
"version" : "4.0.0",
"name" : "Code System based Validation",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "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",
"code" : "validate-code",
"resource" : ["CodeSystem"],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [{
"name" : "url",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "CodeSystem URL. The server must know the code system (e.g. it is defined explicitly in the server'scode systems, or it is known implicitly by the server",
"type" : "uri"
},
{
"name" : "codeSystem",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The codeSystem is provided directly as part of the request. Servers may choose not to accept code systems in this fashion. This parameter is used when the client wants the server to check against a code system that is not stored on the server",
"type" : "CodeSystem"
},
{
"name" : "code",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The code that is to be validated",
"type" : "code"
},
{
"name" : "version",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The version of the code system, if one was provided in the source data",
"type" : "string"
},
{
"name" : "display",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The display associated with the code, if provided. If a display is provided a code must be provided. If no display is provided, the server cannot validate the display value, but may choose to return a recommended display name in an extension in the outcome. Whether displays are case sensitive is code system dependent",
"type" : "string"
},
{
"name" : "coding",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A coding to validate. The system must match the specified code system",
"type" : "Coding"
},
{
"name" : "codeableConcept",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A full codeableConcept to validate. The server returns true if one of the coding values is in the code system, and may also validate that the codings are not in conflict with each other if more than one is present",
"type" : "CodeableConcept"
},
{
"name" : "date",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The date for which the validation should be checked. Normally, this is the current conditions (which is the default values) but under some circumstances, systems need to validate that a correct code was used at some point in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy.",
"type" : "dateTime"
},
{
"name" : "abstract",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "If this parameter has a value of true, the client is stating that the validation is being performed in a context where a concept designated as 'abstract' is appropriate/allowed to be used, and the server should regard abstract codes as valid. If this parameter is false, abstract codes are not considered to be valid.\n\nNote that. 'abstract' is a property defined by many HL7 code systems that indicates that the concept is a logical grouping concept that is not intended to be used asa 'concrete' concept to in an actual patient/care/process record. This language is borrowed from Object Orienated theory where 'asbtract' objects are never instantiated. However in the general record and terminology eco-system, there are many contexts where it is appropraite to use these codes e.g. as decision making criterion, or when editing value sets themselves. This parameter allows a client to indicate to the server that it is working in such a context.",
"type" : "boolean"
},
{
"name" : "displayLanguage",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Specifies the language to be used for description when validating the display property",
"type" : "code"
},
{
"name" : "result",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "True if the concept details supplied are valid",
"type" : "boolean"
},
{
"name" : "message",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "Error details, if result = false. If this is provided when result = true, the message carries hints and warnings",
"type" : "string"
},
{
"name" : "display",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "A valid display for the concept if the system wishes to display this to a user",
"type" : "string"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/Composition-document",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "Composition-document",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Generate a Document
OPERATION: Generate a Document
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Composition-document
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.
\nURL: [base]/Composition/$document
URL: [base]/Composition/[id]/$document
Parameters
Use Name Cardinality Type Binding Documentation IN id 0..1 uri Identifies the composition to use. This can either be a simple id, which identifies a composition, or it can be a full URL, which identifies a composition on another server.
\nNotes:
\n\n- GET [base]/Composition/[id]/$document is identical in meaning to GET [base]/Composition/$document?id=[id]
\n- the id parameter SHALL NOT be used if the operation is requested on a particular composition (e.g. GET [base]/Composition/[id]/$document?id=[id] is not allowed)
\n- Servers are not required to support generating documents on Compositions located on another server
\n
\nIN persist 0..1 boolean Whether to store the document at the bundle end-point (/Bundle) or not once it is generated. Value = true or false (default is for the server to decide). If the document is stored, it's location can be inferred from the Bundle.id, but it SHOULD be provided explicitly in the HTTP Location header in the response
\nIN graph 0..1 uri Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a GraphDefinition that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources
\n
Note: this operation definition does not resolve the question how document signatures are created. This is an open issue during the period of trial use, and feedback is requested regarding this question
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/Composition-document",
"version" : "4.0.0",
"name" : "Generate a Document",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "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.",
"code" : "document",
"comment" : "Note: this operation definition does not resolve the question how document signatures are created. This is an open issue during the period of trial use, and feedback is requested regarding this question",
"resource" : ["Composition"],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [{
"name" : "id",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Identifies the composition to use. This can either be a simple id, which identifies a composition, or it can be a full URL, which identifies a composition on another server. \n\nNotes: \n\n* GET [base]/Composition/[id]/$document is identical in meaning to GET [base]/Composition/$document?id=[id]\n* the id parameter SHALL NOT be used if the operation is requested on a particular composition (e.g. GET [base]/Composition/[id]/$document?id=[id] is not allowed)\n* Servers are not required to support generating documents on Compositions located on another server",
"type" : "uri"
},
{
"name" : "persist",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Whether to store the document at the bundle end-point (/Bundle) or not once it is generated. Value = true or false (default is for the server to decide). If the document is stored, it's location can be inferred from the Bundle.id, but it SHOULD be provided explicitly in the HTTP Location header in the response",
"type" : "boolean"
},
{
"name" : "graph",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a [GraphDefinition](graphdefinition.html) that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources",
"type" : "uri"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/ConceptMap-closure",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "ConceptMap-closure",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Closure Table Maintenance
OPERATION: Closure Table Maintenance
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/ConceptMap-closure
This operation provides support for ongoing maintenance of a client-side transitive closure table based on server-side terminological logic. For details of how this is used, see Maintaining a Closure Table
\nURL: [base]/$closure
Parameters
Use Name Cardinality Type Binding Documentation IN name 1..1 string The name that defines the particular context for the subsumption based closure table
\nIN concept 0..* Coding Concepts to add to the closure table
\nIN version 0..1 string A request to resynchronise - request to send all new entries since the nominated version was sent by the server
\nOUT return 1..1 ConceptMap A list of new entries (code / system --> code/system) that the client should add to its closure table. The only kind of entry mapping equivalences that can be returned are equal, specializes, subsumes and unmatched
\n
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/ConceptMap-closure",
"version" : "4.0.0",
"name" : "Closure Table Maintenance",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "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)",
"code" : "closure",
"resource" : ["ConceptMap"],
"system" : true,
"type" : false,
"instance" : false,
"parameter" : [{
"name" : "name",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The name that defines the particular context for the subsumption based closure table",
"type" : "string"
},
{
"name" : "concept",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Concepts to add to the closure table",
"type" : "Coding"
},
{
"name" : "version",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A request to resynchronise - request to send all new entries since the nominated version was sent by the server",
"type" : "string"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "A list of new entries (code / system --> code/system) that the client should add to its closure table. The only kind of entry mapping equivalences that can be returned are equal, specializes, subsumes and unmatched",
"type" : "ConceptMap"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/ConceptMap-translate",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "ConceptMap-translate",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Concept Translation
OPERATION: Concept Translation
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/ConceptMap-translate
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.
\nOne (and only one) of the in parameters (code, coding, codeableConcept) must be provided, to identify the code that is to be translated.
\nThe 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
\nURL: [base]/ConceptMap/$translate
URL: [base]/ConceptMap/[id]/$translate
Parameters
Use Name Cardinality Type Binding Documentation IN url 0..1 uri A canonical URL for a concept map. The server must know the concept map (e.g. it is defined explicitly in the server's concept maps, or it is defined implicitly by some code system known to the server.
\nIN conceptMap 0..1 ConceptMap The concept map is provided directly as part of the request. Servers may choose not to accept concept maps in this fashion.
\nIN conceptMapVersion 0..1 string The identifier that is used to identify a specific version of the concept map to be used for the translation. This is an arbitrary value managed by the concept map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available.
\nIN code 0..1 code The code that is to be translated. If a code is provided, a system must be provided
\nIN system 0..1 uri The system for the code that is to be translated
\nIN version 0..1 string The version of the system, if one was provided in the source data
\nIN source 0..1 uri Identifies the value set used when the concept (system/code pair) was chosen. May be a logical id, or an absolute or relative location. The source value set is an optional parameter because in some cases, the client cannot know what the source value set is. However, without a source value set, the server may be unable to safely identify an applicable concept map, and would return an error. For this reason, a source value set SHOULD always be provided. Note that servers may be able to identify an appropriate concept map without a source value set if there is a full mapping for the entire code system in the concept map, or by manual intervention
\nIN coding 0..1 Coding A coding to translate
\nIN codeableConcept 0..1 CodeableConcept A full codeableConcept to validate. The server can translate any of the coding values (e.g. existing translations) as it chooses
\nIN target 0..1 uri Identifies the value set in which a translation is sought. May be a logical id, or an absolute or relative location. If there's no target specified, the server should return all known translations, along with their source
\nIN targetsystem 0..1 uri identifies a target code system in which a mapping is sought. This parameter is an alternative to the target parameter - only one is required. Searching for any translation to a target code system irrespective of the context (e.g. target valueset) may lead to unsafe results, and it is at the discretion of the server to decide when to support this operation
\nIN dependency 0..* Another element that may help produce the correct mapping
\nIN dependency.element 0..1 uri The element for this dependency
\nIN dependency.concept 0..1 CodeableConcept The value for this dependency
\nIN reverse 0..1 boolean if this is true, then the operation should return all the codes that might be mapped to this code. This parameter reverses the meaning of the source and target parameters
\nOUT result 1..1 boolean True if the concept could be translated successfully. The value can only be true if at least one returned match has an equivalence which is not unmatched or disjoint
\nOUT message 0..1 string Error details, for display to a human. If this is provided when result = true, the message carries hints and warnings (e.g. a note that the matches could be improved by providing additional detail)
\nOUT match 0..* A concept in the target value set with an equivalence. Note that there may be multiple matches of equal or differing equivalence, and the matches may include equivalence values that mean that there is no match
\nOUT match.equivalence 0..1 code A code indicating the equivalence of the translation, using values from ConceptMapEquivalence
\nOUT match.concept 0..1 Coding The translation outcome. Note that this would never have userSelected = true, since the process of translations implies that the user is not selecting the code (and only the client could know differently)
\nOUT match.product 0..* Another element that is the product of this mapping
\nOUT match.product.element 0..1 uri The element for this product
\nOUT match.product.concept 0..1 Coding The value for this product
\nOUT match.source 0..1 uri The canonical reference to the concept map from which this mapping comes from
\n
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/ConceptMap-translate",
"version" : "4.0.0",
"name" : "Concept Translation",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "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",
"code" : "translate",
"resource" : ["ConceptMap"],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [{
"name" : "url",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A canonical URL for a concept map. The server must know the concept map (e.g. it is defined explicitly in the server's concept maps, or it is defined implicitly by some code system known to the server.",
"type" : "uri"
},
{
"name" : "conceptMap",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The concept map is provided directly as part of the request. Servers may choose not to accept concept maps in this fashion.",
"type" : "ConceptMap"
},
{
"name" : "conceptMapVersion",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The identifier that is used to identify a specific version of the concept map to be used for the translation. This is an arbitrary value managed by the concept map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available.",
"type" : "string"
},
{
"name" : "code",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The code that is to be translated. If a code is provided, a system must be provided",
"type" : "code"
},
{
"name" : "system",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The system for the code that is to be translated",
"type" : "uri"
},
{
"name" : "version",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The version of the system, if one was provided in the source data",
"type" : "string"
},
{
"name" : "source",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Identifies the value set used when the concept (system/code pair) was chosen. May be a logical id, or an absolute or relative location. The source value set is an optional parameter because in some cases, the client cannot know what the source value set is. However, without a source value set, the server may be unable to safely identify an applicable concept map, and would return an error. For this reason, a source value set SHOULD always be provided. Note that servers may be able to identify an appropriate concept map without a source value set if there is a full mapping for the entire code system in the concept map, or by manual intervention",
"type" : "uri"
},
{
"name" : "coding",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A coding to translate",
"type" : "Coding"
},
{
"name" : "codeableConcept",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A full codeableConcept to validate. The server can translate any of the coding values (e.g. existing translations) as it chooses",
"type" : "CodeableConcept"
},
{
"name" : "target",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Identifies the value set in which a translation is sought. May be a logical id, or an absolute or relative location. If there's no target specified, the server should return all known translations, along with their source",
"type" : "uri"
},
{
"name" : "targetsystem",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "identifies a target code system in which a mapping is sought. This parameter is an alternative to the target parameter - only one is required. Searching for any translation to a target code system irrespective of the context (e.g. target valueset) may lead to unsafe results, and it is at the discretion of the server to decide when to support this operation",
"type" : "uri"
},
{
"name" : "dependency",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Another element that may help produce the correct mapping",
"part" : [{
"name" : "element",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The element for this dependency",
"type" : "uri"
},
{
"name" : "concept",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The value for this dependency",
"type" : "CodeableConcept"
}]
},
{
"name" : "reverse",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "if this is true, then the operation should return all the codes that might be mapped to this code. This parameter reverses the meaning of the source and target parameters",
"type" : "boolean"
},
{
"name" : "result",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "True if the concept could be translated successfully. The value can only be true if at least one returned match has an equivalence which is not unmatched or disjoint",
"type" : "boolean"
},
{
"name" : "message",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "Error details, for display to a human. If this is provided when result = true, the message carries hints and warnings (e.g. a note that the matches could be improved by providing additional detail)",
"type" : "string"
},
{
"name" : "match",
"use" : "out",
"min" : 0,
"max" : "*",
"documentation" : "A concept in the target value set with an equivalence. Note that there may be multiple matches of equal or differing equivalence, and the matches may include equivalence values that mean that there is no match",
"part" : [{
"name" : "equivalence",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "A code indicating the equivalence of the translation, using values from [ConceptMapEquivalence](valueset-concept-map-equivalence.html)",
"type" : "code"
},
{
"name" : "concept",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "The translation outcome. Note that this would never have userSelected = true, since the process of translations implies that the user is not selecting the code (and only the client could know differently)",
"type" : "Coding"
},
{
"name" : "product",
"use" : "out",
"min" : 0,
"max" : "*",
"documentation" : "Another element that is the product of this mapping",
"part" : [{
"name" : "element",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "The element for this product",
"type" : "uri"
},
{
"name" : "concept",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "The value for this product",
"type" : "Coding"
}]
},
{
"name" : "source",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "The canonical reference to the concept map from which this mapping comes from",
"type" : "uri"
}]
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/CoverageEligibilityRequest-submit",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "CoverageEligibilityRequest-submit",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Submit an EligibilityRequest resource for assessment
OPERATION: Submit an EligibilityRequest resource for assessment
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/CoverageEligibilityRequest-submit
This operation is used to submit an EligibilityRequest for assessment either as a single EligibilityRequest resource instance or as a Bundle containing the EligibilityRequest and other referenced resources, or Bundle containing a batch of EligibilityRequest resources, either as single EligibilityRequests resources or Bundle resources, for processing. The only input parameter is the single EligibilityRequest or Bundle resource and the only output is a single EligibilityResponse, Bundle of EligibilityResponses or an OperationOutcome resource.
\nURL: [base]/CoverageEligibilityRequest/$submit
Parameters
Use Name Cardinality Type Binding Documentation IN resource 1..1 Resource An EligibilityRequest resource or Bundle of EligibilityRequests, either as individual EligibilityRequest resources or as Bundles each containing a single EligibilityRequest plus referenced resources.
\nOUT return 1..1 Resource An EligibilityResponse resource or Bundle of EligibilityResponse responses, either as individual EligibilityResponse resources or as Bundles each containing a single EligibilityResponse plus referenced resources.
\n
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/CoverageEligibilityRequest-submit",
"version" : "4.0.0",
"name" : "Submit an EligibilityRequest resource for assessment",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "This operation is used to submit an EligibilityRequest for assessment either as a single EligibilityRequest resource instance or as a Bundle containing the EligibilityRequest and other referenced resources, or Bundle containing a batch of EligibilityRequest resources, either as single EligibilityRequests resources or Bundle resources, for processing. The only input parameter is the single EligibilityRequest or Bundle resource and the only output is a single EligibilityResponse, Bundle of EligibilityResponses or an OperationOutcome resource.",
"code" : "submit",
"resource" : ["CoverageEligibilityRequest"],
"system" : false,
"type" : true,
"instance" : false,
"parameter" : [{
"name" : "resource",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "An EligibilityRequest resource or Bundle of EligibilityRequests, either as individual EligibilityRequest resources or as Bundles each containing a single EligibilityRequest plus referenced resources.",
"type" : "Resource"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "An EligibilityResponse resource or Bundle of EligibilityResponse responses, either as individual EligibilityResponse resources or as Bundles each containing a single EligibilityResponse plus referenced resources.",
"type" : "Resource"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/Encounter-everything",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "Encounter-everything",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Fetch Encounter Record
OPERATION: Fetch Encounter Record
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Encounter-everything
This operation is used to return all the information related to an encounter described in the resource on which this operation is invoked. The response is a bundle of type "searchset". At a minimum, the encounter resource itself is returned, along with any other resources that the server has available for the given encounter for the user. The server also returns whatever resources are needed to support the records - e.g. linked practitioners, locations, organizations etc. The principle intended use for this operation is to provide a patient with access to their record, or to allow a client to retrieve everything for an encounter for efficient display).
\nThe server SHOULD return all resources it has that:
\n\n- are included in the encounter compartment for the identified encounter (have a reference to the encounter)
\n- are referenced by the standard extenstion for associating an encounter (where no reference element exists) http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
\n- the server believes are relevant to the context of the encounter for any other reason (internally defined/decided)
\n- any resource referenced by the above, including binaries and attachments (to make a more complete package)
\n
\nIn the US Realm, at a mimimum, the resources returned SHALL include all the data covered by the meaningful use common data elements (see DAF for further guidance). Other applicable implementation guides may make additional rules about the information that is returned. Note that for many resources, the exact nature of the link to encounter can be ambiguous (e.g. for a DiagnosticReport, is it the encounter when it was initiated, or when it was reported?)
\nURL: [base]/Encounter/[id]/$everything
Parameters
Use Name Cardinality Type Binding Documentation IN _since 0..1 instant Resources updated after this period will be included in the response. The intent of this parameter is to allow a client to request only records that have changed since the last request, based on either the return header time, or or (for asynchronous use), the transaction time
\nIN _type 0..* code One or more parameters, each containing one or more comma-delimited FHIR resource types to include in the return resources. In the absense of any specified types, the server returns all resource types
\nIN _count 0..1 integer See discussion below on the utility of paging through the results of the $everything operation
\nOUT return 1..1 Bundle The bundle type is "searchset"
\n
The key differences between this operation and simply searching the encounter compartment are:
\n\n- unless the client requests otherwise, the server returns the entire result set in a single bundle (rather than using paging)
\n- the server is responsible for determining what resources to return as included resources (rather than the client specifying which ones)
\n
\nThis frees the client from needing to determine what it could or should ask for, particularly with regard to included resources. Servers should consider returning appropriate Provenance and AuditTrail on the returned resources, even though these are not directly part of the patient compartment.
\nIt is assumed that the server has identified and secured the context appropriately, and can either associate the authorization context with a single encounter, or determine whether the context has the rights to the nominated encounter, if there is one, or can determine an appropriate list of encouners to provide data for from the context of the request. If there is no nominated encounter (GET /Encounter/$everything) and the context is not associated with a single encounter record, the actual list of encounters is all encounters that the user associated with the request has access to. In such cases, the server may choose to return an error rather than all the records. Specifying the relationship between the context, a user and encounter records is outside the scope of this specification (though see The Smart App Launch Implementation Guide.
\nWhen this operation is used to access multiple encounter records at once, the return bundle could be rather a lot of data; servers may choose to require that such requests are made asynchronously, and associated with bulk data formats. Alternatively, clients may choose to page through the result set (or servers may require this). Paging through the results is done the same as for Searching, using the _count parameter, and Bundle links. Implementers should note that paging will be slower than simply returning all the results at once (more network traffic, multiple latency delays) but may be required in order not to exhaust available memory reading or writing the whole response in a single package. Unlike searching, there is no inherent user-display order for the $everything operation. Servers might consider sorting the returned resources in descending order of last record update, but are not required to do so. Servers should consider returning appropriate Provenance and AuditTrail on the returned resources, even though these are not directly part of the patient compartment.
\nThe _since parameter is provided to support periodic queries to get additional information that has changed about the encounter since the last query. This means that the _since parameter is based on record time. The value of the _since parameter should be set to the time from the server. If using direct response, this is the timestamp in the response header. If using the async interface, this is the transaction timestamp in the json response. Servers should ensure that the timestamps a managed such that the client does not miss any changes. Clients should be able to handle getting the same response more than once in the case that the transaction falls on a time boundary. Clients should ensure that the other query parameters are constant to ensure a coherent set of records when doing periodic queries.
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/Encounter-everything",
"version" : "4.0.0",
"name" : "Fetch Encounter Record",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "This operation is used to return all the information related to an encounter described in the resource on which this operation is invoked. The response is a bundle of type \"searchset\". At a minimum, the encounter resource itself is returned, along with any other resources that the server has available for the given encounter for the user. The server also returns whatever resources are needed to support the records - e.g. linked practitioners, locations, organizations etc. The principle intended use for this operation is to provide a patient with access to their record, or to allow a client to retrieve everything for an encounter for efficient display).\r\rThe server SHOULD return all resources it has that:\r\r* are included in the encounter compartment for the identified encounter (have a reference to the encounter)\r* are referenced by the standard extenstion for associating an encounter (where no reference element exists) http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter\r* the server believes are relevant to the context of the encounter for any other reason (internally defined/decided)\r* any resource referenced by the above, including binaries and attachments (to make a more complete package)\r\rIn the US Realm, at a mimimum, the resources returned SHALL include all the data covered by the meaningful use common data elements (see [DAF](http://hl7.org/fhir/us/daf) for further guidance). Other applicable implementation guides may make additional rules about the information that is returned. Note that for many resources, the exact nature of the link to encounter can be ambiguous (e.g. for a DiagnosticReport, is it the encounter when it was initiated, or when it was reported?)",
"code" : "everything",
"comment" : "The key differences between this operation and simply searching the encounter compartment are: \n\n* unless the client requests otherwise, the server returns the entire result set in a single bundle (rather than using paging) \n* the server is responsible for determining what resources to return as included resources (rather than the client specifying which ones)\n\nThis frees the client from needing to determine what it could or should ask for, particularly with regard to included resources. Servers should consider returning appropriate Provenance and AuditTrail on the returned resources, even though these are not directly part of the patient compartment. \n\nIt is assumed that the server has identified and secured the context appropriately, and can either associate the authorization context with a single encounter, or determine whether the context has the rights to the nominated encounter, if there is one, or can determine an appropriate list of encouners to provide data for from the context of the request. If there is no nominated encounter (GET /Encounter/$everything) and the context is not associated with a single encounter record, the actual list of encounters is all encounters that the user associated with the request has access to. In such cases, the server may choose to return an error rather than all the records. Specifying the relationship between the context, a user and encounter records is outside the scope of this specification (though see [The Smart App Launch Implementation Guide](http://hl7.org/fhir/smart-app-launch). \n\nWhen this operation is used to access multiple encounter records at once, the return bundle could be rather a lot of data; servers may choose to require that such requests are made [asynchronously](async.html), and associated with [bulk data formats](formats.html#bulk). Alternatively, clients may choose to page through the result set (or servers may require this). Paging through the results is done the same as for [Searching](http.html#paging), using the [_count](search.html#count) parameter, and Bundle links. Implementers should note that paging will be slower than simply returning all the results at once (more network traffic, multiple latency delays) but may be required in order not to exhaust available memory reading or writing the whole response in a single package. Unlike searching, there is no inherent user-display order for the $everything operation. Servers might consider sorting the returned resources in descending order of last record update, but are not required to do so. Servers should consider returning appropriate Provenance and AuditTrail on the returned resources, even though these are not directly part of the patient compartment.\n\nThe _since parameter is provided to support periodic queries to get additional information that has changed about the encounter since the last query. This means that the _since parameter is based on record time. The value of the _since parameter should be set to the time from the server. If using direct response, this is the timestamp in the response header. If using the async interface, this is the transaction timestamp in the json response. Servers should ensure that the timestamps a managed such that the client does not miss any changes. Clients should be able to handle getting the same response more than once in the case that the transaction falls on a time boundary. Clients should ensure that the other query parameters are constant to ensure a coherent set of records when doing periodic queries.",
"resource" : ["Encounter"],
"system" : false,
"type" : false,
"instance" : true,
"parameter" : [{
"name" : "_since",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Resources updated after this period will be included in the response. The intent of this parameter is to allow a client to request only records that have changed since the last request, based on either the return header time, or or (for asynchronous use), the transaction time",
"type" : "instant"
},
{
"name" : "_type",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "One or more parameters, each containing one or more comma-delimited FHIR resource types to include in the return resources. In the absense of any specified types, the server returns all resource types",
"type" : "code"
},
{
"name" : "_count",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "See discussion below on the utility of paging through the results of the $everything operation",
"type" : "integer"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The bundle type is \"searchset\"",
"type" : "Bundle"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/Group-everything",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "Group-everything",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Fetch a group of Patient Records
OPERATION: Fetch a group of Patient Records
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Group-everything
This operation is used to return all the information related to one or more patients that are part of the group on which this operation is invoked. The response is a bundle of type "searchset". At a minimum, the patient resource(s) itself is returned, along with any other resources that the server has that are related to the patient(s), and that are available for the given user. The server also returns whatever resources are needed to support the records - e.g. linked practitioners, medications, locations, organizations etc. The intended use for this operation is for a provider or other user to perform a bulk data download. The server SHOULD return at least all resources that it has that are in the patient compartment for the identified patient(s), and any resource referenced from those, including binaries and attachments. In the US Realm, at a mimimum, the resources returned SHALL include all the data covered by the meaningful use common data elements as defined in US-Core. Other applicable implementation guides may make additional rules about how much information that is returned.
\nURL: [base]/Group/[id]/$everything
Parameters
Use Name Cardinality Type Binding Documentation IN start 0..1 date The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no start date is provided, all records prior to the end date are in scope.
\nIN end 0..1 date The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no end date is provided, all records subsequent to the start date are in scope.
\nIN _since 0..1 instant Resources updated after this period will be included in the response. The intent of this parameter is to allow a client to request only records that have changed since the last request, based on either the return header time, or or (for asynchronous use), the transaction time
\nIN _type 0..* code One or more parameters, each containing one or more comma-delimited FHIR resource types to include in the return resources. In the absense of any specified types, the server returns all resource types
\nIN _count 0..1 integer See discussion below on the utility of paging through the results of the $everything operation
\nOUT return 1..1 Bundle The bundle type is "searchset"
\n
The key differences between this operation and simply searching the group's patients compartment are:
\n\n- unless the client requests otherwise, the server returns the entire result set in a single bundle (rather than using paging)
\n- the server is responsible for determining what resources to return as included resources (rather than the client specifying which ones).
\n
\nThis frees the client from needing to determine what it could or should ask for, particularly with regard to included resources.
\nIt is assumed that the server has identified and secured the context appropriately, and can either associate the authorization context with a particular group, or determine whether the context has the rights to the nominated group, if there is one, or can determine an appropriate list of groups to provide data for from the context of the request. If there is no nominated group (GET /Group/$everything) and the context is not associated with a single group record, the actual list of groups is all groups that the user associated with the request has access to. In such cases, the server may choose to return an error rather than all the records (and is likely to do so, but not required to). Specifying the relationship between the context, a user and groups is outside the scope of this specification (though see The Smart App Launch Implementation Guide.
\nThe return bundle from this operation is usually rather a lot of data; servers typically choose to require that such requests are made asynchronously, and associated with bulk data formats. Alternatively, clients may choose to page through the result set (or servers may require this). Paging through the results is done the same as for Searching, using the _count parameter, and Bundle links. Implementers should note that paging will be slower than simply returning all the results at once (more network traffic, multiple latency delays) but may be required in order not to exhaust available memory reading or writing the whole response in a single package. Unlike searching, there is no inherent user-display order for the $everything operation. Servers might consider sorting the returned resources in descending order of last record update, but are not required to do so.
\nThe _since parameter is provided to support periodic queries to get additional information that has changed about the group since the last query. This means that the _since parameter is based on record time. The value of the _since parameter should be set to the time from the server. If using direct response, this is the timestamp in the response header. If using the async interface, this is the transaction timestamp in the json response. Servers should ensure that the timestamps a managed such that the client does not miss any changes. Clients should be able to handle getting the same response more than once in the case that the transaction falls on a time boundary. Clients should ensure that the other query parameters are constant to ensure a coherent set of records when doing periodic queries.
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/Group-everything",
"version" : "4.0.0",
"name" : "Fetch a group of Patient Records",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "This operation is used to return all the information related to one or more patients that are part of the group on which this operation is invoked. The response is a bundle of type \"searchset\". At a minimum, the patient resource(s) itself is returned, along with any other resources that the server has that are related to the patient(s), and that are available for the given user. The server also returns whatever resources are needed to support the records - e.g. linked practitioners, medications, locations, organizations etc. The intended use for this operation is for a provider or other user to perform a bulk data download. The server SHOULD return at least all resources that it has that are in the patient compartment for the identified patient(s), and any resource referenced from those, including binaries and attachments. In the US Realm, at a mimimum, the resources returned SHALL include all the data covered by the meaningful use common data elements as defined in [US-Core](http://hl7.org/fhir/us/coref). Other applicable implementation guides may make additional rules about how much information that is returned.",
"code" : "everything",
"comment" : "The key differences between this operation and simply searching the group's patients compartment are: \n\n* unless the client requests otherwise, the server returns the entire result set in a single bundle (rather than using paging) \n* the server is responsible for determining what resources to return as included resources (rather than the client specifying which ones). \n\nThis frees the client from needing to determine what it could or should ask for, particularly with regard to included resources. \n\nIt is assumed that the server has identified and secured the context appropriately, and can either associate the authorization context with a particular group, or determine whether the context has the rights to the nominated group, if there is one, or can determine an appropriate list of groups to provide data for from the context of the request. If there is no nominated group (GET /Group/$everything) and the context is not associated with a single group record, the actual list of groups is all groups that the user associated with the request has access to. In such cases, the server may choose to return an error rather than all the records (and is likely to do so, but not required to). Specifying the relationship between the context, a user and groups is outside the scope of this specification (though see [The Smart App Launch Implementation Guide](http://hl7.org/fhir/smart-app-launch). \n\nThe return bundle from this operation is usually rather a lot of data; servers typically choose to require that such requests are made [asynchronously](async.html), and associated with [bulk data formats](formats.html#bulk). Alternatively, clients may choose to page through the result set (or servers may require this). Paging through the results is done the same as for [Searching](http.html#paging), using the [_count](search.html#count) parameter, and Bundle links. Implementers should note that paging will be slower than simply returning all the results at once (more network traffic, multiple latency delays) but may be required in order not to exhaust available memory reading or writing the whole response in a single package. Unlike searching, there is no inherent user-display order for the $everything operation. Servers might consider sorting the returned resources in descending order of last record update, but are not required to do so.\n\nThe _since parameter is provided to support periodic queries to get additional information that has changed about the group since the last query. This means that the _since parameter is based on record time. The value of the _since parameter should be set to the time from the server. If using direct response, this is the timestamp in the response header. If using the async interface, this is the transaction timestamp in the json response. Servers should ensure that the timestamps a managed such that the client does not miss any changes. Clients should be able to handle getting the same response more than once in the case that the transaction falls on a time boundary. Clients should ensure that the other query parameters are constant to ensure a coherent set of records when doing periodic queries.",
"resource" : ["Group"],
"system" : false,
"type" : false,
"instance" : true,
"parameter" : [{
"name" : "start",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no start date is provided, all records prior to the end date are in scope.",
"type" : "date"
},
{
"name" : "end",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no end date is provided, all records subsequent to the start date are in scope.",
"type" : "date"
},
{
"name" : "_since",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Resources updated after this period will be included in the response. The intent of this parameter is to allow a client to request only records that have changed since the last request, based on either the return header time, or or (for asynchronous use), the transaction time",
"type" : "instant"
},
{
"name" : "_type",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "One or more parameters, each containing one or more comma-delimited FHIR resource types to include in the return resources. In the absense of any specified types, the server returns all resource types",
"type" : "code"
},
{
"name" : "_count",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "See discussion below on the utility of paging through the results of the $everything operation",
"type" : "integer"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The bundle type is \"searchset\"",
"type" : "Bundle"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/Library-data-requirements",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "Library-data-requirements",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Data Requirements
OPERATION: Data Requirements
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Library-data-requirements
The data-requirements operation aggregates and returns the parameters and data requirements for a resource and all its dependencies as a single module definition
\nURL: [base]/$data-requirements
URL: [base]/Library/[id]/$data-requirements
Parameters
Use Name Cardinality Type Binding Documentation IN target 0..1 string The target of the data requirements operation
\nOUT return 1..1 Library The result of the requirements gathering
\n
The effect of invoking this operation is to determine the aggregate set of data requirements and dependencies for a given target resource. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the target resource and any libraries referenced by it. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements)
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/Library-data-requirements",
"version" : "4.0.0",
"name" : "Data Requirements",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "The data-requirements operation aggregates and returns the parameters and data requirements for a resource and all its dependencies as a single module definition",
"code" : "data-requirements",
"comment" : "The effect of invoking this operation is to determine the aggregate set of data requirements and dependencies for a given target resource. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the target resource and any libraries referenced by it. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements)",
"resource" : ["Library"],
"system" : true,
"type" : false,
"instance" : true,
"parameter" : [{
"name" : "target",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The target of the data requirements operation",
"type" : "string"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The result of the requirements gathering",
"type" : "Library"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/List-find",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "List-find",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Find a functional list
OPERATION: Find a functional list
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/List-find
This operation allows a client to find an identified list for a particular function by its function. The operation takes two parameters, the identity of a patient, and the name of a functional list. The list of defined functional lists can be found at Current Resource Lists. Applications are not required to support all the lists, and may define additional lists of their own. If the system is able to locate a list that serves the identified purpose, it returns it as the body of the response with a 200 OK status. If the resource cannot be located, the server returns a 404 not found (optionally with an OperationOutcome resource)
\nURL: [base]/List/$find
Parameters
Use Name Cardinality Type Binding Documentation IN patient 1..1 id The id of a patient resource located on the server on which this operation is executed
\nIN name 1..1 code The code for the functional list that is being found
\n
Note that servers may support searching by a functional list, and not support this operation that allows clients to find the list directly
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/List-find",
"version" : "4.0.0",
"name" : "Find a functional list",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "This operation allows a client to find an identified list for a particular function by its function. The operation takes two parameters, the identity of a patient, and the name of a functional list. The list of defined functional lists can be found at [Current Resource Lists](lifecycle.html#lists). Applications are not required to support all the lists, and may define additional lists of their own. If the system is able to locate a list that serves the identified purpose, it returns it as the body of the response with a 200 OK status. If the resource cannot be located, the server returns a 404 not found (optionally with an OperationOutcome resource)",
"code" : "find",
"comment" : "Note that servers may support searching by a functional list, and not support this operation that allows clients to find the list directly",
"resource" : ["List"],
"system" : false,
"type" : true,
"instance" : false,
"parameter" : [{
"name" : "patient",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The id of a patient resource located on the server on which this operation is executed",
"type" : "id"
},
{
"name" : "name",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The code for the functional list that is being found",
"type" : "code"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/Measure-care-gaps",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "Measure-care-gaps",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Care Gaps
OPERATION: Care Gaps
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Measure-care-gaps
The care-gaps operation is used to determine gaps-in-care based on the results of quality measures
\nURL: [base]/Measure/$care-gaps
Parameters
Use Name Cardinality Type Binding Documentation IN periodStart 1..1 date The start of the measurement period. In keeping with the semantics of the date parameter used in the FHIR search operation, the period will start at the beginning of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period s
\nIN periodEnd 1..1 date The end of the measurement period. The period will end at the end of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period end to be 2014-12-31T23:59:59 inclusive
\nIN topic 1..1 string The topic to be used to determine which measures are considered for the care gaps report. Any measure with the given topic will be included in the report
\nIN subject 1..1 string
(reference) Subject for which the care gaps report will be produced
\nOUT return 1..1 Bundle The result of the care gaps report will be returned as a document bundle with a MeasureReport entry for each included measure
\n
The effect of invoking this operation is to calculate a set of measures for a particular topic (e.g. Preventive Care and Screening) and return a document describing the results of each measure for the given subject. Note that it is up to the server to determine whether or not the generated care gaps report is persisted. If the server does not persist the results, the operation does not affect state and can be invoked with a GET
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/Measure-care-gaps",
"version" : "4.0.0",
"name" : "Care Gaps",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "The care-gaps operation is used to determine gaps-in-care based on the results of quality measures",
"code" : "care-gaps",
"comment" : "The effect of invoking this operation is to calculate a set of measures for a particular topic (e.g. Preventive Care and Screening) and return a document describing the results of each measure for the given subject. Note that it is up to the server to determine whether or not the generated care gaps report is persisted. If the server does not persist the results, the operation does not affect state and can be invoked with a GET",
"resource" : ["Measure"],
"system" : false,
"type" : true,
"instance" : false,
"parameter" : [{
"name" : "periodStart",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The start of the measurement period. In keeping with the semantics of the date parameter used in the FHIR search operation, the period will start at the beginning of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period s",
"type" : "date"
},
{
"name" : "periodEnd",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The end of the measurement period. The period will end at the end of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period end to be 2014-12-31T23:59:59 inclusive",
"type" : "date"
},
{
"name" : "topic",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The topic to be used to determine which measures are considered for the care gaps report. Any measure with the given topic will be included in the report",
"type" : "string"
},
{
"name" : "subject",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Subject for which the care gaps report will be produced",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The result of the care gaps report will be returned as a document bundle with a MeasureReport entry for each included measure",
"type" : "Bundle"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/Measure-collect-data",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "Measure-collect-data",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Collect Data
OPERATION: Collect Data
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Measure-collect-data
The collect-data operation is used to collect the data-of-interest for the given measure.
\nURL: [base]/Measure/$collect-data
URL: [base]/Measure/[id]/$collect-data
Parameters
Use Name Cardinality Type Binding Documentation IN periodStart 1..1 date The start of the measurement period. In keeping with the semantics of the date parameter used in the FHIR search operation, the period will start at the beginning of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period s
\nIN periodEnd 1..1 date The end of the measurement period. The period will end at the end of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period end to be 2014-12-31T23:59:59 inclusive
\nIN measure 0..1 string
(reference) The measure to evaluate. This parameter is only required when the operation is invoked on the resource type, it is not used when invoking the operation on a Measure instance
\nIN subject 0..1 string
(reference) Subject for which the measure will be collected. If not specified, measure data will be collected for all subjects that meet the requirements of the measure. If specified, the measure will only be calculated for the referenced subject(s)
\nIN practitioner 0..1 string
(reference) Practitioner for which the measure will be collected. If specified, measure data will be collected only for subjects that have a primary relationship to the identified practitioner
\nIN lastReceivedOn 0..1 dateTime The date the results of this measure were last received. This parameter used to indicate when the last time data for this measure was collected. This information is used to support incremental data collection scenarios
\nOUT measureReport 1..1 MeasureReport A MeasureReport of type data-collection detailing the results of the operation
\nOUT resource 0..* Resource The result resources that make up the data-of-interest for the measure
\n
The effect of invoking this operation is to gather the data required to perform an evaluation of the measure. If the lastReceivedOn parameter is supplied, only data that is new or has been changed since the lastReceivedOn date is included in the response. Note that the resulting MeasureReport is a transient resource
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/Measure-collect-data",
"version" : "4.0.0",
"name" : "Collect Data",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "The collect-data operation is used to collect the data-of-interest for the given measure.",
"code" : "collect-data",
"comment" : "The effect of invoking this operation is to gather the data required to perform an evaluation of the measure. If the lastReceivedOn parameter is supplied, only data that is new or has been changed since the lastReceivedOn date is included in the response. Note that the resulting MeasureReport is a transient resource",
"resource" : ["Measure"],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [{
"name" : "periodStart",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The start of the measurement period. In keeping with the semantics of the date parameter used in the FHIR search operation, the period will start at the beginning of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period s",
"type" : "date"
},
{
"name" : "periodEnd",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The end of the measurement period. The period will end at the end of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period end to be 2014-12-31T23:59:59 inclusive",
"type" : "date"
},
{
"name" : "measure",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The measure to evaluate. This parameter is only required when the operation is invoked on the resource type, it is not used when invoking the operation on a Measure instance",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "subject",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Subject for which the measure will be collected. If not specified, measure data will be collected for all subjects that meet the requirements of the measure. If specified, the measure will only be calculated for the referenced subject(s)",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "practitioner",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Practitioner for which the measure will be collected. If specified, measure data will be collected only for subjects that have a primary relationship to the identified practitioner",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "lastReceivedOn",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The date the results of this measure were last received. This parameter used to indicate when the last time data for this measure was collected. This information is used to support incremental data collection scenarios",
"type" : "dateTime"
},
{
"name" : "measureReport",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "A MeasureReport of type data-collection detailing the results of the operation",
"type" : "MeasureReport"
},
{
"name" : "resource",
"use" : "out",
"min" : 0,
"max" : "*",
"documentation" : "The result resources that make up the data-of-interest for the measure",
"type" : "Resource"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/Measure-data-requirements",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "Measure-data-requirements",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Data Requirements
OPERATION: Data Requirements
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Measure-data-requirements
The data-requirements operation aggregates and returns the parameters and data requirements for the measure and all its dependencies as a single module definition
\nURL: [base]/Measure/[id]/$data-requirements
Parameters
Use Name Cardinality Type Binding Documentation IN periodStart 1..1 date The start of the measurement period. In keeping with the semantics of the date parameter used in the FHIR search operation, the period will start at the beginning of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period start to be 2014-01-01T00:00:00 inclusive
\nIN periodEnd 1..1 date The end of the measurement period. The period will end at the end of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period end to be 2014-12-31T23:59:59 inclusive
\nOUT return 1..1 Library The result of the requirements gathering is a module-definition Library that describes the aggregate parameters, data requirements, and dependencies of the measure
\n
The effect of invoking this operation is to determine the aggregate set of data requirements and dependencies for the measure. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the libraries referenced by the measures. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements). This operation defines what resources are subsequently referenced in the evaluatedResources element of the MeasureReport when submitting measure data
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/Measure-data-requirements",
"version" : "4.0.0",
"name" : "Data Requirements",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "The data-requirements operation aggregates and returns the parameters and data requirements for the measure and all its dependencies as a single module definition",
"code" : "data-requirements",
"comment" : "The effect of invoking this operation is to determine the aggregate set of data requirements and dependencies for the measure. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the libraries referenced by the measures. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements). This operation defines what resources are subsequently referenced in the evaluatedResources element of the MeasureReport when submitting measure data",
"resource" : ["Measure"],
"system" : false,
"type" : false,
"instance" : true,
"parameter" : [{
"name" : "periodStart",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The start of the measurement period. In keeping with the semantics of the date parameter used in the FHIR search operation, the period will start at the beginning of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period start to be 2014-01-01T00:00:00 inclusive",
"type" : "date"
},
{
"name" : "periodEnd",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The end of the measurement period. The period will end at the end of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period end to be 2014-12-31T23:59:59 inclusive",
"type" : "date"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The result of the requirements gathering is a module-definition Library that describes the aggregate parameters, data requirements, and dependencies of the measure",
"type" : "Library"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/Measure-evaluate-measure",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "Measure-evaluate-measure",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Evaluate Measure
OPERATION: Evaluate Measure
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Measure-evaluate-measure
The evaluate-measure operation is used to calculate an eMeasure and obtain the results
\nURL: [base]/Measure/$evaluate-measure
URL: [base]/Measure/[id]/$evaluate-measure
Parameters
Use Name Cardinality Type Binding Documentation IN periodStart 1..1 date The start of the measurement period. In keeping with the semantics of the date parameter used in the FHIR search operation, the period will start at the beginning of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period start to be 2014-01-01T00:00:00 inclusive
\nIN periodEnd 1..1 date The end of the measurement period. The period will end at the end of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period end to be 2014-12-31T23:59:59 inclusive
\nIN measure 0..1 string
(reference) The measure to evaluate. This parameter is only required when the operation is invoked on the resource type, it is not used when invoking the operation on a Measure instance
\nIN reportType 0..1 code The type of measure report: subject, subject-list, or population. If not specified, a default value of subject will be used if the subject parameter is supplied, otherwise, population will be used
\nIN subject 0..1 string
(reference) Subject for which the measure will be calculated. If not specified, the measure will be calculated for all subjects that meet the requirements of the measure. If specified, the measure will only be calculated for the referenced subject(s)
\nIN practitioner 0..1 string
(reference) Practitioner for which the measure will be calculated. If specified, the measure will be calculated only for subjects that have a primary relationship to the identified practitioner
\nIN lastReceivedOn 0..1 dateTime The date the results of this measure were last received. This parameter is only valid for patient-level reports and is used to indicate when the last time a result for this patient was received. This information can be used to limit the set of resources returned for a patient-level report
\nOUT return 1..1 MeasureReport The results of the measure calculation. See the MeasureReport resource for a complete description of the output of this operation. Note that implementations may choose to return a MeasureReport with a status of pending to indicate that the report is still being generated. In this case, the client can use a polling method to continually request the MeasureReport until the status is updated to complete
\n
The effect of invoking this operation is to calculate the measure for the given subject, or all subjects if no subject is supplied, and return the results as a MeasureReport resource of the appropriate type. Note that whether or not this operation affects the state of the server depends on whether the server persists the generated MeasureReport. If the MeasureReport is not persisted, this operation can be invoked with GET
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/Measure-evaluate-measure",
"version" : "4.0.0",
"name" : "Evaluate Measure",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "The evaluate-measure operation is used to calculate an eMeasure and obtain the results",
"code" : "evaluate-measure",
"comment" : "The effect of invoking this operation is to calculate the measure for the given subject, or all subjects if no subject is supplied, and return the results as a MeasureReport resource of the appropriate type. Note that whether or not this operation affects the state of the server depends on whether the server persists the generated MeasureReport. If the MeasureReport is not persisted, this operation can be invoked with GET",
"resource" : ["Measure"],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [{
"name" : "periodStart",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The start of the measurement period. In keeping with the semantics of the date parameter used in the FHIR search operation, the period will start at the beginning of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period start to be 2014-01-01T00:00:00 inclusive",
"type" : "date"
},
{
"name" : "periodEnd",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The end of the measurement period. The period will end at the end of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period end to be 2014-12-31T23:59:59 inclusive",
"type" : "date"
},
{
"name" : "measure",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The measure to evaluate. This parameter is only required when the operation is invoked on the resource type, it is not used when invoking the operation on a Measure instance",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "reportType",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The type of measure report: subject, subject-list, or population. If not specified, a default value of subject will be used if the subject parameter is supplied, otherwise, population will be used",
"type" : "code"
},
{
"name" : "subject",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Subject for which the measure will be calculated. If not specified, the measure will be calculated for all subjects that meet the requirements of the measure. If specified, the measure will only be calculated for the referenced subject(s)",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "practitioner",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Practitioner for which the measure will be calculated. If specified, the measure will be calculated only for subjects that have a primary relationship to the identified practitioner",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "lastReceivedOn",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The date the results of this measure were last received. This parameter is only valid for patient-level reports and is used to indicate when the last time a result for this patient was received. This information can be used to limit the set of resources returned for a patient-level report",
"type" : "dateTime"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The results of the measure calculation. See the MeasureReport resource for a complete description of the output of this operation. Note that implementations may choose to return a MeasureReport with a status of pending to indicate that the report is still being generated. In this case, the client can use a polling method to continually request the MeasureReport until the status is updated to complete",
"type" : "MeasureReport"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/Measure-submit-data",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "Measure-submit-data",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Submit Data
OPERATION: Submit Data
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Measure-submit-data
The submit-data operation is used to submit data-of-interest for a measure. There is no expectation that the submitted data represents all the data-of-interest, only that all the data submitted is relevant to the calculation of the measure for a particular subject or population
\nURL: [base]/Measure/$submit-data
URL: [base]/Measure/[id]/$submit-data
Parameters
Use Name Cardinality Type Binding Documentation IN measureReport 1..1 MeasureReport The measure report being submitted
\nIN resource 0..* Resource The individual resources that make up the data-of-interest being submitted
\n
The effect of invoking this operation is that the submitted data is posted to the receiving system and can be used for subsequent calculation of the relevant quality measure. The data-of-interest for a measure can be determined by examining the measure definition, or by invoking the $data-requirements operation
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/Measure-submit-data",
"version" : "4.0.0",
"name" : "Submit Data",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "The submit-data operation is used to submit data-of-interest for a measure. There is no expectation that the submitted data represents all the data-of-interest, only that all the data submitted is relevant to the calculation of the measure for a particular subject or population",
"code" : "submit-data",
"comment" : "The effect of invoking this operation is that the submitted data is posted to the receiving system and can be used for subsequent calculation of the relevant quality measure. The data-of-interest for a measure can be determined by examining the measure definition, or by invoking the $data-requirements operation",
"resource" : ["Measure"],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [{
"name" : "measureReport",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The measure report being submitted",
"type" : "MeasureReport"
},
{
"name" : "resource",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "The individual resources that make up the data-of-interest being submitted",
"type" : "Resource"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/MedicinalProduct-everything",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "MedicinalProduct-everything",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Fetch Product Record
OPERATION: Fetch Product Record
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/MedicinalProduct-everything
This operation is used to return all the information related to one or more products described in the resource or context on which this operation is invoked. The response is a bundle of type "searchset". At a minimum, the product resource(s) itself is returned, along with any other resources that the server has that are related to the products(s), and that are available for the given user. This is typically the marketing authorisations, ingredients, packages, therapeutic indications and so on. The server also returns whatever resources are needed to support the records - e.g. linked organizations, document references etc.
\nURL: [base]/MedicinalProduct/$everything
URL: [base]/MedicinalProduct/[id]/$everything
Parameters
Use Name Cardinality Type Binding Documentation IN _since 0..1 instant Resources updated after this period will be included in the response. The intent of this parameter is to allow a client to request only records that have changed since the last request, based on either the return header time, or or (for asynchronous use), the transaction time
\nIN _count 0..1 integer See discussion below on the utility of paging through the results of the $everything operation
\nOUT return 1..1 Bundle The bundle type is "searchset"
\n
The key differences between this operation and simply performing a search and using _include and _revinclude are:
\n\n- unless the client requests otherwise, the server returns the entire result set in a single bundle (rather than using paging)
\n- the server is responsible for determining what resources to return as included resources (rather than the client specifying which ones).
\n
\nThis frees the client from needing to determine what it could or should ask for, particularly with regard to included resources. It also makes for a much shorter and easier to construct query string. Servers should consider returning appropriate Provenance and AuditTrail on the returned resources, even though these are not directly part of the product data.
\nWhen this operation is used to access multiple product records at once, the return bundle could be rather a lot of data; servers may choose to require that such requests are made asynchronously, and associated with bulk data formats. Alternatively, clients may choose to page through the result set (or servers may require this). Paging through the results is done the same as for Searching, using the _count parameter, and Bundle links. Implementers should note that paging will be slower than simply returning all the results at once (more network traffic, multiple latency delays) but may be required in order not to exhaust available memory reading or writing the whole response in a single package. Unlike searching, there is no inherent user-display order for the $everything operation. Servers might consider sorting the returned resources in descending order of last record update, but are not required to do so.
\nThe _since parameter is provided to support periodic queries to get additional information that has changed about the product since the last query. This means that the _since parameter is based on record time. The value of the _since parameter should be set to the time from the server. If using direct response, this is the timestamp in the response header. If using the async interface, this is the transaction timestamp in the json response. Servers should ensure that the timestamps a managed such that the client does not miss any changes. Clients should be able to handle getting the same response more than once in the case that the transaction falls on a time boundary. Clients should ensure that the other query parameters are constant to ensure a coherent set of records when doing periodic queries.
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/MedicinalProduct-everything",
"version" : "4.0.0",
"name" : "Fetch Product Record",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "This operation is used to return all the information related to one or more products described in the resource or context on which this operation is invoked. The response is a bundle of type \"searchset\". At a minimum, the product resource(s) itself is returned, along with any other resources that the server has that are related to the products(s), and that are available for the given user. This is typically the marketing authorisations, ingredients, packages, therapeutic indications and so on. The server also returns whatever resources are needed to support the records - e.g. linked organizations, document references etc.",
"code" : "everything",
"comment" : "The key differences between this operation and simply performing a search and using _include and _revinclude are: \n\n* unless the client requests otherwise, the server returns the entire result set in a single bundle (rather than using paging) \n* the server is responsible for determining what resources to return as included resources (rather than the client specifying which ones). \n\nThis frees the client from needing to determine what it could or should ask for, particularly with regard to included resources. It also makes for a much shorter and easier to construct query string. Servers should consider returning appropriate Provenance and AuditTrail on the returned resources, even though these are not directly part of the product data. \n\nWhen this operation is used to access multiple product records at once, the return bundle could be rather a lot of data; servers may choose to require that such requests are made [asynchronously](async.html), and associated with [bulk data formats](formats.html#bulk). Alternatively, clients may choose to page through the result set (or servers may require this). Paging through the results is done the same as for [Searching](http.html#paging), using the [_count](search.html#count) parameter, and Bundle links. Implementers should note that paging will be slower than simply returning all the results at once (more network traffic, multiple latency delays) but may be required in order not to exhaust available memory reading or writing the whole response in a single package. Unlike searching, there is no inherent user-display order for the $everything operation. Servers might consider sorting the returned resources in descending order of last record update, but are not required to do so.\n\nThe _since parameter is provided to support periodic queries to get additional information that has changed about the product since the last query. This means that the _since parameter is based on record time. The value of the _since parameter should be set to the time from the server. If using direct response, this is the timestamp in the response header. If using the async interface, this is the transaction timestamp in the json response. Servers should ensure that the timestamps a managed such that the client does not miss any changes. Clients should be able to handle getting the same response more than once in the case that the transaction falls on a time boundary. Clients should ensure that the other query parameters are constant to ensure a coherent set of records when doing periodic queries.",
"resource" : ["MedicinalProduct"],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [{
"name" : "_since",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Resources updated after this period will be included in the response. The intent of this parameter is to allow a client to request only records that have changed since the last request, based on either the return header time, or or (for asynchronous use), the transaction time",
"type" : "instant"
},
{
"name" : "_count",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "See discussion below on the utility of paging through the results of the $everything operation",
"type" : "integer"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The bundle type is \"searchset\"",
"type" : "Bundle"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "MessageHeader-process-message",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Process Message
OPERATION: Process Message
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message
This operation accepts a message, processes it according to the definition of the event in the message header, and returns one or more response messages.
\nIn addition to processing the message event, a server may choose to retain all or some the resources and make them available on a RESTful interface, but is not required to do so.
\nURL: [base]/$process-message
Parameters
Use Name Cardinality Type Binding Documentation IN content 1..1 Bundle The message to process (or, if using asynchronous messaging, it may be a response message to accept)
\nIN async 0..1 boolean If 'true' the message is processed using the asynchronous messaging pattern
\nIN response-url 0..1 url A URL to submit response messages to, if asynchronous messaging is being used, and if the MessageHeader.source.endpoint is not the appropriate place to submit responses
\nOUT return 0..1 Bundle A response message, if synchronous messaging is being used (mandatory in this case). For asynchronous messaging, there is no return value
\n
This operation does not use the parameters resource; the parameters "async" and "response-url" always go in the URL, if they are used, and the "content" parameter is always the body of the HTTP message.
\nWhen processing messages, a server may return one of several status codes:
\n\n- 200 OK: Indicates that the message has been fully processed. If an application-level response is expected for the submitted message, that response SHALL be returned as the body of the 200 response.
\n- 202 Accepted: Indicates that the receiving system has accepted custody of the message
\n- 204 No Content: Indicates that the message has been fully processed and would normally have had an application-level response, but because of instructions from the sender (e.g. the messageheader-response-request extension), no response is being provided
\n- 300+: Indicates that the message was not successfully processed. The server MAY return an OperationOutcome with additional information, and SHOULD do so if the response code is 400 or greater.<br/>\nThe client SHALL interpret a 4xx response to indicate that there is no point resubmitting the unaltered message, and a 5xx response to indicate an unexpected error occurred on the part of the server, with the implication that it may be appropriate to resubmit the original message. Doing so SHOULD NOT result in a duplicate message response. Repeated failures indicate either a fatal problem with the submission or a problem with the receiving application.
\n
\nThe following rules apply when using $process-message:
\n\n- The operation only accepts POST transactions - any other HTTP method will result in an HTTP error
\n- The request content type submitted is always Bundle with type "message" containing a Message Header resource as the first resource
\n- The response content type returned is always Bundle with type "message" containing a Message Header resource as the first resource, or an HTTP error
\n- If the response is an error, the body SHOULD be an Errors ∓ Warning resource with full details
\n- The mailbox may be authenticated using standard HTTP authentication methods, including OAuth
\n
\nThe $process-message operation can be used by any HTTP end-point that accepts FHIR messages, not just FHIR RESTful servers.
\nIn order to ensure consistency of processing, the logical rules regarding processing of Bundle.id and message id SHALL be followed when messages are processed using this operation.
\nThe $process-message operation may be used synchronously, or asynchronously.
\nThe following rules apply when using the $process-message operation synchronously:
\n\n- The URL (http://server/base/$process-message) has no parameters
\n- It is an error if the sender POSTs a message that requires multiple response messages
\n- Servers SHALL accept multiple concurrent message submissions and process them correctly (they are allowed to process them sequentially internally, but multiple concurrent submissions is not an error in its own right)
\n
\nThe following rules apply when using the $process-message operation asynchronously:
\n\n- The URL has at least one parameter: http://server/base/$process-message?async=true
\n- The server acknowledges the message with a 200 OK with no body, or returns an HTTP error if the message cannot be processed
\n- Accepting the message means that the server has understood the message enough to know where to respond
\n- An OperationOutcome SHOULD be returned in either case
\n- By default, the server responds by invoking the $process-message using the sender's stated end-point in the message: POST [MessageHeader.source.endpoint]/$process-messages]
\n- Since the source end-point may be manipulated by message transfer engines, an alternative response address may be specified using the parameter "response-url": http://server/base/$process-message?async=true&response-url=http://server2.com/base/anything. The endpoint at the specified URL SHALL implement the signature of the $process-message operation (parameter async=true, accept a Bundle, return a 200 OK or an error)
\n- The server submits response messages to the appropriate end-point with the parameter async=true. There is no response message for the response messages
\n
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 4
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message",
"version" : "4.0.0",
"name" : "Process Message",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "This operation accepts a message, processes it according to the definition of the event in the message header, and returns one or more response messages. \n\nIn addition to processing the message event, a server may choose to retain all or some the resources and make them available on a RESTful interface, but is not required to do so.",
"code" : "process-message",
"comment" : "This operation does not use the parameters resource; the parameters \"async\" and \"response-url\" always go in the URL, if they are used, and the \"content\" parameter is always the body of the HTTP message.\n\nWhen processing messages, a server may return one of several status codes:\n* **200 OK**: Indicates that the message has been fully processed. If an application-level response is expected for the submitted message, that response SHALL be returned as the body of the 200 response.\n* **202 Accepted**: Indicates that the receiving system has accepted custody of the message\n* **204 No Content**: Indicates that the message has been fully processed and would normally have had an application-level response, but because of instructions from the sender (e.g. the [messageheader-response-request](extension-messageheader-response-request.html) extension), no response is being provided\n* **300+**: Indicates that the message was not successfully processed. The server MAY return an [OperationOutcome](operationoutcome.html) with additional information, and SHOULD do so if the response code is 400 or greater.
\n The client SHALL interpret a 4xx response to indicate that there is no point resubmitting the unaltered message, and a 5xx response to indicate an unexpected error occurred on the part of the server, with the implication that it may be appropriate to resubmit the original message. Doing so SHOULD NOT result in a duplicate message response. Repeated failures indicate either a fatal problem with the submission or a problem with the receiving application.\n\nThe following rules apply when using $process-message:\n\n* The operation only accepts POST transactions - any other HTTP method will result in an HTTP error\n* The request content type submitted is always [Bundle](bundle.html) with type \"message\" containing a [Message Header](messageheader.html) resource as the first resource\n* The response content type returned is always [Bundle](bundle.html) with type \"message\" containing a [Message Header](messageheader.html) resource as the first resource, or an HTTP error\n* If the response is an error, the body SHOULD be an [Errors ∓ Warning](operationoutcome.html) resource with full details\n* The mailbox may be authenticated using standard HTTP authentication methods, including OAuth\n\nThe $process-message operation can be used by any HTTP end-point that accepts FHIR messages, not just FHIR RESTful servers.\n\nIn order to ensure consistency of processing, the [logical rules regarding processing of Bundle.id and message id](messaging.html#reliable) SHALL be followed when messages are processed using this operation.\n\nThe $process-message operation may be used synchronously, or asynchronously.\n\nThe following rules apply when using the $process-message operation synchronously:\n\n* The URL (http://server/base/$process-message) has no parameters\n* It is an error if the sender POSTs a message that requires multiple response messages\n* Servers SHALL accept multiple concurrent message submissions and process them correctly (they are allowed to process them sequentially internally, but multiple concurrent submissions is not an error in its own right)\n\nThe following rules apply when using the $process-message operation asynchronously:\n\n* The URL has at least one parameter: http://server/base/$process-message?async=true\n* The server acknowledges the message with a 200 OK with no body, or returns an HTTP error if the message cannot be processed\n* Accepting the message means that the server has understood the message enough to know where to respond\n* An [OperationOutcome](operationoutcome.html) SHOULD be returned in either case\n* By default, the server responds by invoking the $process-message using the sender's stated end-point in the message: POST [MessageHeader.source.endpoint]/$process-messages]\n* Since the source end-point may be manipulated by message transfer engines, an alternative response address may be specified using the parameter \"response-url\": http://server/base/$process-message?async=true&response-url=http://server2.com/base/anything. The endpoint at the specified URL SHALL implement the signature of the $process-message operation (parameter async=true, accept a Bundle, return a 200 OK or an error)\n* The server submits response messages to the appropriate end-point with the parameter async=true. There is no response message for the response messages",
"resource" : ["MessageHeader"],
"system" : true,
"type" : false,
"instance" : false,
"parameter" : [{
"name" : "content",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The message to process (or, if using asynchronous messaging, it may be a response message to accept)",
"type" : "Bundle"
},
{
"name" : "async",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "If 'true' the message is processed using the asynchronous messaging pattern",
"type" : "boolean"
},
{
"name" : "response-url",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A URL to submit response messages to, if asynchronous messaging is being used, and if the MessageHeader.source.endpoint is not the appropriate place to submit responses",
"type" : "url"
},
{
"name" : "return",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "A response message, if synchronous messaging is being used (mandatory in this case). For asynchronous messaging, there is no return value",
"type" : "Bundle"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/NamingSystem-preferred-id",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "NamingSystem-preferred-id",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Fetch Preferred it
OPERATION: Fetch Preferred it
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/NamingSystem-preferred-id
This operation returns the preferred identifiers for identifiers, and terminologies. The operation takes 2 parameters:
\n\n- a system identifier - either a URI, an OID, or a v2 table 0396 (other) code
\n- a code for what kind of identifier is desired (URI, OID, v2 table 0396 identifier)
\n
\nand returns either the requested identifier, or an HTTP errors response with an OperationOutcome because either the provided identifier was not recognized, or the requested identiifer type is not known.
\nThe principle use of this operation is when converting between v2, CDA and FHIR Identifier/CX/II and CodeableConcepts/C(N/W)E/CD but the operation may also find use when converting metadata such as profiles.
\nURL: [base]/NamingSystem/$preferred-id
Parameters
Use Name Cardinality Type Binding Documentation IN id 1..1 string The server parses the provided id to see what type it is (mary a URI, an OID as a URI, a plain OID, or a v2 table 0396 code). If the server can't tell what type of identifier it is, it can try it as multiple types. It is an error if more than one system matches the provided identifier
\nIN type 1..1 code http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.0.0 (Required) OUT result 1..1 string OIDs are return as plain OIDs (not the URI form).
\n
Servers handle this request by finding the provided identifier in their known naming systems, and returning the requested identifier type (NamingSystem.uniqueId.type). If there are multiple possible identifiers of the specified type (e.g. multiple OIDs) the server returns an error.
\nIf the server wishes, it can also look through all code systems and value sets it knows about when attempting to find the requested identifier
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/NamingSystem-preferred-id",
"version" : "4.0.0",
"name" : "Fetch Preferred it",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "This operation returns the preferred identifiers for identifiers, and terminologies. The operation takes 2 parameters: \n\n* a system identifier - either a URI, an OID, or a v2 table 0396 (other) code \n* a code for what kind of identifier is desired (URI, OID, v2 table 0396 identifier) \n\nand returns either the requested identifier, or an HTTP errors response with an OperationOutcome because either the provided identifier was not recognized, or the requested identiifer type is not known. \n\nThe principle use of this operation is when converting between v2, CDA and FHIR Identifier/CX/II and CodeableConcepts/C(N/W)E/CD but the operation may also find use when converting metadata such as profiles.",
"code" : "preferred-id",
"comment" : "Servers handle this request by finding the provided identifier in their known naming systems, and returning the requested identifier type ([NamingSystem.uniqueId.type](namingsystem-definitions.html#NamingSystem.uniqueId.type)). If there are multiple possible identifiers of the specified type (e.g. multiple OIDs) the server returns an error. \n\nIf the server wishes, it can also look through all code systems and value sets it knows about when attempting to find the requested identifier",
"resource" : ["NamingSystem"],
"system" : false,
"type" : true,
"instance" : false,
"parameter" : [{
"name" : "id",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The server parses the provided id to see what type it is (mary a URI, an OID as a URI, a plain OID, or a v2 table 0396 code). If the server can't tell what type of identifier it is, it can try it as multiple types. It is an error if more than one system matches the provided identifier",
"type" : "string"
},
{
"name" : "type",
"use" : "in",
"min" : 1,
"max" : "1",
"type" : "code",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.0.0"
}
},
{
"name" : "result",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "OIDs are return as plain OIDs (not the URI form).",
"type" : "string"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/Observation-lastn",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "Observation-lastn",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Last N Observations Query
OPERATION: Last N Observations Query
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Observation-lastn
The lastn query meets the common need for searching for the most recent or last n=number of observations for a subject. For example, retrieving the last 5 temperatures for a patient to view trends or fetching the most recent laboratory results or vitals signs. To ask a server to return the last n=number of observations, the lastn query uses the normal search parameters defined for the Observation resource. However, rather than their normal use, they are interpreted as inputs - i.e.. instead of requiring that the resources literally contain the search parameters, they are passed to a server algorithm of some kind that uses them to determine the most appropriate matches.
\nThe request for a lastn query SHALL include:
\n\n- A
$lastn
operation parameter \n- A subject using either the
patient
or subject
search parameter \n- A
category
parameter and/or a search parameter that contains a code element in its FHIRpath expression. ( e.g., code
or code-value-concept
) \n
\nThe request for a lastn query MAY include:
\n\n- Other Observation search parameters and modifiers
\n
\nThe response from a lastn query is a set of observations:
\n\n- Filtered by additional parameters\n
\n- If not explicitly filtered by status then will include statuses of 'entered-in-error'
\n
\n \n- 'GROUP BY'
Observation.code
\n\n- Codes SHALL be considered equivalent if the
coding.value
and coding.system
are the same. \n- Text only codes SHALL be treated and grouped based on the text.
\n- For codes with translations (multiple codings), the code translations are assumed to be equal and the grouping by code SHALL follow the transitive property of equality.
\n
\n \n
\nfor example:
\n\n\nObservation.code for observation a Observation.code for observation b Observation.code for observation c number of groups [codes/text in each group] \n\n\na b c 3 [a],[b],[c] \na b a,c 2 [a.c],[b] \na b a,b 1 [a,b] \n'textM' 'Text' 't e x t' 3 ['text'],['Text'],['t e x t'] \n\n
\n\n- Sorted from most recent to the oldest
\n- Limited to the number of requested responses per group specified by the optional max query parameter\n
\n- In case of a tie - when the effective times for >1 Observations are equal - both will be returned. Therefore, more Observations may be returned than is specified in max. For example, 4 Observations instead of 3 if the 3rd and 4th most recent observation had the same effective time.
\n
\n \n- If no maximum number is given then only the most recent Observation in each group is returned.
\n
\nThe set of returned observations should represent distinct real world observations and not the same observation with changes in status or versions. If there are no matches, the lastn query SHALL return an empty search set with no error, but may include an operation outcome with further advice.
\nURL: [base]/Observation/$lastn
Parameters
Use Name Cardinality Type Binding Documentation IN max 0..1 positiveInt max
is an optional input parameter to the lastn query operation. It is used to specify the maximum number of Observations to return from each group. For example for the query "Fetch the last 3 results for all vitals for a patient" max
= 3.
\nOUT return 1..1 Bundle The set of most recent N Observations that match the lastn query search criteria.
\n
The key differences between this query operation and simply searching Observation using the combination of _count
and _sort
parameters are:
\n\n- The lastn query returns only the last N resource grouped by code. Using the _count query method doesn't restrict the total matches so you may need to page through several "A" Observations before getting to Observation "B".
\n- The server is responsible for grouping the observations by codes. This frees the client from needing to determine which codes she should ask for.
\n
\nThis operation cannot be performed on observations that the user is not authorized to see. It is assumed that the server has identified and secured the context appropriately, and can either associate the authorization context with a single patient, or determine whether the context has the rights to the nominated patient, if there is one. If there is no nominated patient (e.g. the operation is invoked at the system level) and the context is not associated with a single patient record, then the server should return an error. Specifying the relationship between the context, a user and patient records is outside the scope of this specification.
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/Observation-lastn",
"version" : "4.0.0",
"name" : "Last N Observations Query",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "The *lastn query* meets the common need for searching for the most recent or last n=number of observations for a subject. For example, retrieving the last 5 temperatures for a patient to view trends or fetching the most recent laboratory results or vitals signs. To ask a server to return the last n=number of observations, the *lastn* query uses the [normal search parameters](observation.html#search) defined for the Observation resource. However, rather than their normal use, they are interpreted as inputs - i.e.. instead of requiring that the resources literally contain the search parameters, they are passed to a server algorithm of some kind that uses them to determine the most appropriate matches.\n\nThe request for a lastn query SHALL include:\n\n* A `$lastn` operation parameter\n* A subject using either the `patient` or `subject` search parameter\n* A `category` parameter and/or a search parameter that contains a code element in its FHIRpath expression. ( e.g., `code` or `code-value-concept`)\n\nThe request for a lastn query MAY include:\n\n* Other Observation search parameters and modifiers\n\nThe response from a lastn query is a set of observations:\n\n* Filtered by additional parameters\n * If not explicitly filtered by status then will include statuses of 'entered-in-error'\n* 'GROUP BY' `Observation.code`\n * Codes SHALL be considered equivalent if the `coding.value` *and* `coding.system` are the same.\n * Text only codes SHALL be treated and grouped based on the text.\n * For codes with translations (multiple codings), the code translations are assumed to be equal and the grouping by code SHALL follow the transitive property of equality.\n\nfor example:\n\n|Observation.code for observation a|Observation.code for observation b|Observation.code for observation c|number of groups [codes/text in each group]| \n|---|---|---|---| \n|a|b|c | 3 [a],[b],[c]| \n|a|b|a,c | 2 [a.c],[b]| \n|a|b|a,b | 1 [a,b]| \n|'textM'|'Text'|'t e x t'|3 ['text'],['Text'],['t e x t']|\n\n* Sorted from most recent to the oldest\n* Limited to the number of requested responses per group specified by the optional *max* query parameter\n * In case of a tie - when the effective times for >1 Observations are equal - both will be returned. Therefore, more Observations may be returned than is specified in *max*. For example, 4 Observations instead of 3 if the 3rd and 4th most recent observation had the same effective time.\n* If no maximum number is given then only the most recent Observation in each group is returned.\n\nThe set of returned observations should represent distinct real world observations and not the same observation with changes in status or versions. If there are no matches, the *lastn* query SHALL return an empty search set with no error, but may include an operation outcome with further advice.",
"code" : "lastn",
"comment" : "The key differences between this query operation and simply searching Observation using the combination of `_count` and `_sort` parameters are:\r\r* The *lastn* query returns **only** the last N resource grouped by code. Using the _count query method doesn't restrict the total matches so you may need to page through several \"A\" Observations before getting to Observation \"B\".\r* The server is responsible for grouping the observations by codes. This frees the client from needing to determine which codes she should ask for.\r\rThis operation cannot be performed on observations that the user is not authorized to see. It is assumed that the server has identified and secured the context appropriately, and can either associate the authorization context with a single patient, or determine whether the context has the rights to the nominated patient, if there is one. If there is no nominated patient (e.g. the operation is invoked at the system level) and the context is not associated with a single patient record, then the server should return an error. Specifying the relationship between the context, a user and patient records is outside the scope of this specification.",
"resource" : ["Observation"],
"system" : false,
"type" : true,
"instance" : false,
"parameter" : [{
"name" : "max",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "`max` is an optional input parameter to the *lastn* query operation. It is used to specify the maximum number of Observations to return from each group. For example for the query \"Fetch the last 3 results for all vitals for a patient\" `max` = 3.",
"type" : "positiveInt"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The set of most recent N Observations that match the *lastn* query search criteria.",
"type" : "Bundle"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/Observation-stats",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "Observation-stats",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Observation Statistics
OPERATION: Observation Statistics
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Observation-stats
The Statistics operation performs a set of statistical calculations on a set of clinical measurements such as a blood pressure as stored on the server. This operation evaluates Observation resources having valueQuantity elements that have UCUM unit codes. Observations with a status of 'entered-in-error' will be excluded from the calculations.
\nThe set of Observations is defined by 4 parameters:
\n\n- the subject of the observations for which the statistics are being generated (
subject
) \n- which observations to generate statistics for (
code
and system
, or coding
) \n- the time period over which to generate statistics 'duration
or
period`) \n- the set of statistical analyses to return (
statistic
) \n
\nPossible statistical analyses (see StatisticsCode):
\n\n- average ("Average"): The mean of N measurements over the stated period.
\n- maximum ("Maximum"): The maximum value of N measurements over the stated period.
\n- minimum ("Minimum"): The minimum value of N measurements over the stated period.
\n- count ("Count"): The [number] of valid measurements over the stated period that contributed to the other statistical outputs.
\n- total-count ("Total Count"): The total [number] of valid measurements over the stated period, including observations that were ignored because they did not contain valid result values.
\n- median ("Median"): The median of N measurements over the stated period.
\n- std-dev ("Standard Deviation"): The standard deviation of N measurements over the stated period.
\n- sum ("Sum"): The sum of N measurements over the stated period.
\n- variance ("Variance"): The variance of N measurements over the stated period.
\n- 20-percent ("20th Percentile"): The 20th Percentile of N measurements over the stated period.
\n- 80-percent ("80th Percentile"): The 80th Percentile of N measurements over the stated period.
\n- 4-lower ("Lower Quartile"): The lower Quartile Boundary of N measurements over the stated period.
\n- 4-upper ("Upper Quartile"): The upper Quartile Boundary of N measurements over the stated period.
\n- 4-dev ("Quartile Deviation"): The difference between the upper and lower Quartiles is called the Interquartile range. (IQR = Q3-Q1) Quartile deviation or Semi-interquartile range is one-half the difference between the first and the third quartiles.
\n- 5-1 ("1st Quintile"): The lowest of four values that divide the N measurements into a frequency distribution of five classes with each containing one fifth of the total population.
\n- 5-2 ("2nd Quintile"): The second of four values that divide the N measurements into a frequency distribution of five classes with each containing one fifth of the total population.
\n- 5-3 ("3rd Quintile"): The third of four values that divide the N measurements into a frequency distribution of five classes with each containing one fifth of the total population.
\n- 5-4 ("4th Quintile"): The fourth of four values that divide the N measurements into a frequency distribution of five classes with each containing one fifth of the total population.
\n- skew ("Skew"): Skewness is a measure of the asymmetry of the probability distribution of a real-valued random variable about its mean. The skewness value can be positive or negative, or even undefined. Source: Wikipedia.
\n- kurtosis ("Kurtosis"): Kurtosis is a measure of the "tailedness" of the probability distribution of a real-valued random variable. Source: Wikipedia.
\n- regression ("Regression"): Linear regression is an approach for modeling two-dimensional sample points with one independent variable and one dependent variable (conventionally, the x and y coordinates in a Cartesian coordinate system) and finds a linear function (a non-vertical straight line) that, as accurately as possible, predicts the dependent variable values as a function of the independent variables. Source: Wikipedia This Statistic code will return both a gradient and an intercept value.
\n
\nIf successful, the operation returns an Observation resource for each code with the results of the statistical calculations as component value pairs where the component code = the statistical code. The Observation also contains the input parameters patient
,code
and duration
parameters. If unsuccessful, an OperationOutcome with an error message will be returned.
\nThe client can request that all the observations on which the statistics are based be returned as well, using the include parameter. If an include parameter is specified, a limit may also be specified; the sources observations are subsetted at the server's discretion if count > limit. This functionality is included with the intent of supporting graphical presentation
\nURL: [base]/Observation/$stats
Parameters
Use Name Cardinality Type Binding Documentation IN subject 1..1 uri The subject of the relevant Observations, which has the value of the Observation.subject.reference. E.g. 'Patient/123'. Reference can be to an absolute URL, but servers only perform stats on their own observations
\nIN code 0..* string The test code(s) upon which the statistics are being performed. Provide along with a system, or as a coding. For example, the LOINC code =\n2339-0 (Glucose [Mass/volume] in Blood) will evaluate all relevant Observations with this code in Observation.code
and Observation.component.code
. For LOINC codes that are panels, e.g., 85354-9(Blood pressure panel with all children optional), the stats operation returns statistics for each of the individual panel measurements. That means it will include and evaluate all values grouped by code for all the individual observations that are: 1) referenced in .related
for .related.type
= 'has-member' and 2) component observations in Observation.component
.
\nIN system 0..1 uri The system for the code(s). Or provide a coding instead
\nIN coding 0..* Coding The test code upon which the statistics are being performed, as a Coding
\nIN duration 0..1 decimal The time period of interest given as hours. For example, the duration = "1" represents the last hour - the time period from on hour ago to now
\nIN period 0..1 Period The time period over which the calculations to be performed, if a duration is not provided
\nIN statistic 1..* code average|max|min|count The statistical operations to be performed on the relevant operations. Multiple statistics operations can be specified. These codes are defined here
\nIN include 0..1 boolean Whether to return the observations on which the statistics are based
\nIN limit 0..1 positiveInt If an include parameter is specified, a limit may also be specified to limit the number of source Observations returned. If the include paramter is absent or equal to "false" the limit parameter SHALL be ignored by the server
\nOUT statistics 1..* Observation A set of observations, one observation for each code, each containing one component for each statistic. The Observation.component.code contains the statistic, and is relative to the Observation.code and cannot be interpreted independently. The Observation will also contain a subject, effectivePeriod, and code reflecting the input parameters. The status is fixed to final
.
\nOUT source 0..* Observation Source observations on which the statistics are based
\n
If modifier extensions are present in the Observation, they must be accounted for by implementers. A modifier extension may affect the observation.value in a way that it should be excluded from the from the calculations.
\nThis operation cannot be performed on observations that the user is not authorized to see. It is assumed that the server has identified and secured the context appropriately, and can either associate the authorization context with a single patient, or determine whether the context has the rights to the nominated patient, if there is one. If there is no nominated patient (e.g. the operation is invoked at the system level) and the context is not associated with a single patient record, then the server should return an error. Specifying the relationship between the context, a user and patient records is outside the scope of this specification.
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/Observation-stats",
"version" : "4.0.0",
"name" : "Observation Statistics",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "The Statistics operation performs a set of statistical calculations on a set of clinical measurements such as a blood pressure as stored on the server. This operation evaluates [Observation](observation.html) resources having valueQuantity elements that have UCUM unit codes. Observations with a status of 'entered-in-error' will be excluded from the calculations. \r\rThe set of Observations is defined by 4 parameters:\r\r* the subject of the observations for which the statistics are being generated (`subject`)\r* which observations to generate statistics for (`code` and `system`, or `coding`)\r* the time period over which to generate statistics 'duration` or `period`)\r* the set of statistical analyses to return (`statistic`)\r\rPossible statistical analyses (see [StatisticsCode](valueset-observation-statistics.html)):\r\r - **average** (\"Average\"): The [mean](https://en.wikipedia.org/wiki/Arithmetic_mean) of N measurements over the stated period.\r\n - **maximum** (\"Maximum\"): The [maximum](https://en.wikipedia.org/wiki/Maximal_element) value of N measurements over the stated period.\r\n - **minimum** (\"Minimum\"): The [minimum](https://en.wikipedia.org/wiki/Minimal_element) value of N measurements over the stated period.\r\n - **count** (\"Count\"): The [number] of valid measurements over the stated period that contributed to the other statistical outputs.\r\n - **total-count** (\"Total Count\"): The total [number] of valid measurements over the stated period, including observations that were ignored because they did not contain valid result values.\r\n - **median** (\"Median\"): The [median](https://en.wikipedia.org/wiki/Median) of N measurements over the stated period.\r\n - **std-dev** (\"Standard Deviation\"): The [standard deviation](https://en.wikipedia.org/wiki/Standard_deviation) of N measurements over the stated period.\r\n - **sum** (\"Sum\"): The [sum](https://en.wikipedia.org/wiki/Summation) of N measurements over the stated period.\r\n - **variance** (\"Variance\"): The [variance](https://en.wikipedia.org/wiki/Variance) of N measurements over the stated period.\r\n - **20-percent** (\"20th Percentile\"): The 20th [Percentile](https://en.wikipedia.org/wiki/Percentile) of N measurements over the stated period.\r\n - **80-percent** (\"80th Percentile\"): The 80th [Percentile](https://en.wikipedia.org/wiki/Percentile) of N measurements over the stated period.\r\n - **4-lower** (\"Lower Quartile\"): The lower [Quartile](https://en.wikipedia.org/wiki/Quartile) Boundary of N measurements over the stated period.\r\n - **4-upper** (\"Upper Quartile\"): The upper [Quartile](https://en.wikipedia.org/wiki/Quartile) Boundary of N measurements over the stated period.\r\n - **4-dev** (\"Quartile Deviation\"): The difference between the upper and lower [Quartiles](https://en.wikipedia.org/wiki/Quartile) is called the Interquartile range. (IQR = Q3-Q1) Quartile deviation or Semi-interquartile range is one-half the difference between the first and the third quartiles.\r\n - **5-1** (\"1st Quintile\"): The lowest of four values that divide the N measurements into a frequency distribution of five classes with each containing one fifth of the total population.\r\n - **5-2** (\"2nd Quintile\"): The second of four values that divide the N measurements into a frequency distribution of five classes with each containing one fifth of the total population.\r\n - **5-3** (\"3rd Quintile\"): The third of four values that divide the N measurements into a frequency distribution of five classes with each containing one fifth of the total population.\r\n - **5-4** (\"4th Quintile\"): The fourth of four values that divide the N measurements into a frequency distribution of five classes with each containing one fifth of the total population.\r\n - **skew** (\"Skew\"): Skewness is a measure of the asymmetry of the probability distribution of a real-valued random variable about its mean. The skewness value can be positive or negative, or even undefined. Source: [Wikipedia](https://en.wikipedia.org/wiki/Skewness).\r\n - **kurtosis** (\"Kurtosis\"): Kurtosis is a measure of the \"tailedness\" of the probability distribution of a real-valued random variable. Source: [Wikipedia](https://en.wikipedia.org/wiki/Kurtosis).\r\n - **regression** (\"Regression\"): Linear regression is an approach for modeling two-dimensional sample points with one independent variable and one dependent variable (conventionally, the x and y coordinates in a Cartesian coordinate system) and finds a linear function (a non-vertical straight line) that, as accurately as possible, predicts the dependent variable values as a function of the independent variables. Source: [Wikipedia](https://en.wikipedia.org/wiki/Simple_linear_regression) This Statistic code will return both a gradient and an intercept value.\r\n\r\rIf successful, the operation returns an Observation resource for each code with the results of the statistical calculations as component value pairs where the component code = the statistical code. The Observation also contains the input parameters `patient`,`code` and `duration` parameters. If unsuccessful, an [OperationOutcome](operationoutcome.html) with an error message will be returned.\r\rThe client can request that all the observations on which the statistics are based be returned as well, using the include parameter. If an include parameter is specified, a limit may also be specified; the sources observations are subsetted at the server's discretion if count > limit. This functionality is included with the intent of supporting graphical presentation",
"code" : "stats",
"comment" : "If [modifier extensions](extensibility.html#modifierExtension) are present in the Observation, they must be accounted for by implementers. A modifier extension may affect the observation.value in a way that it should be excluded from the from the calculations.\r\rThis operation cannot be performed on observations that the user is not authorized to see. It is assumed that the server has identified and secured the context appropriately, and can either associate the authorization context with a single patient, or determine whether the context has the rights to the nominated patient, if there is one. If there is no nominated patient (e.g. the operation is invoked at the system level) and the context is not associated with a single patient record, then the server should return an error. Specifying the relationship between the context, a user and patient records is outside the scope of this specification.",
"resource" : ["Observation"],
"system" : false,
"type" : true,
"instance" : false,
"parameter" : [{
"name" : "subject",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The subject of the relevant Observations, which has the value of the Observation.subject.reference. E.g. 'Patient/123'. Reference can be to an absolute URL, but servers only perform stats on their own observations",
"type" : "uri"
},
{
"name" : "code",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "The test code(s) upon which the statistics are being performed. Provide along with a system, or as a coding. For example, the LOINC code = \r2339-0 (Glucose [Mass/volume] in Blood) will evaluate all relevant Observations with this code in `Observation.code` and `Observation.component.code`. For LOINC codes that are panels, e.g., 85354-9(Blood pressure panel with all children optional), the stats operation returns statistics for each of the individual panel measurements. That means it will include and evaluate all values grouped by code for all the individual observations that are: 1) referenced in `.related` for `.related.type` = 'has-member' and 2) component observations in `Observation.component`.",
"type" : "string"
},
{
"name" : "system",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The system for the code(s). Or provide a coding instead",
"type" : "uri"
},
{
"name" : "coding",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "The test code upon which the statistics are being performed, as a Coding",
"type" : "Coding"
},
{
"name" : "duration",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The time period of interest given as hours. For example, the duration = \"1\" represents the last hour - the time period from on hour ago to now",
"type" : "decimal"
},
{
"name" : "period",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The time period over which the calculations to be performed, if a duration is not provided",
"type" : "Period"
},
{
"name" : "statistic",
"use" : "in",
"min" : 1,
"max" : "*",
"documentation" : "average|max|min|count The statistical operations to be performed on the relevant operations. Multiple statistics operations can be specified. These codes are defined [here](valueset-observation-statistics.html)",
"type" : "code"
},
{
"name" : "include",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Whether to return the observations on which the statistics are based",
"type" : "boolean"
},
{
"name" : "limit",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "If an include parameter is specified, a limit may also be specified to limit the number of source Observations returned. If the include paramter is absent or equal to \"false\" the limit parameter SHALL be ignored by the server",
"type" : "positiveInt"
},
{
"name" : "statistics",
"use" : "out",
"min" : 1,
"max" : "*",
"documentation" : "A set of observations, one observation for each code, each containing one component for each statistic. The Observation.component.code contains the statistic, and is relative to the Observation.code and cannot be interpreted independently. The Observation will also contain a subject, effectivePeriod, and code reflecting the input parameters. The status is fixed to `final`.",
"type" : "Observation"
},
{
"name" : "source",
"use" : "out",
"min" : 0,
"max" : "*",
"documentation" : "Source observations on which the statistics are based",
"type" : "Observation"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/Patient-everything",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "Patient-everything",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Fetch Patient Record
OPERATION: Fetch Patient Record
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Patient-everything
This operation is used to return all the information related to one or more patients described in the resource or context on which this operation is invoked. The response is a bundle of type "searchset". At a minimum, the patient resource(s) itself is returned, along with any other resources that the server has that are related to the patient(s), and that are available for the given user. The server also returns whatever resources are needed to support the records - e.g. linked practitioners, medications, locations, organizations etc.
\nThe intended use for this operation is to provide a patient with access to their entire record (e.g. "Blue Button"), or for provider or other user to perform a bulk data download. The server SHOULD return at least all resources that it has that are in the patient compartment for the identified patient(s), and any resource referenced from those, including binaries and attachments. In the US Realm, at a minimum, the resources returned SHALL include all the data covered by the meaningful use common data elements as defined in the US Core Implementation Guide. Other applicable implementation guides may make additional rules about how much information that is returned.
\nURL: [base]/Patient/$everything
URL: [base]/Patient/[id]/$everything
Parameters
Use Name Cardinality Type Binding Documentation IN start 0..1 date The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no start date is provided, all records prior to the end date are in scope.
\nIN end 0..1 date The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no end date is provided, all records subsequent to the start date are in scope.
\nIN _since 0..1 instant Resources updated after this period will be included in the response. The intent of this parameter is to allow a client to request only records that have changed since the last request, based on either the return header time, or or (for asynchronous use), the transaction time
\nIN _type 0..* code One or more parameters, each containing one or more comma-delimited FHIR resource types to include in the return resources. In the absence of any specified types, the server returns all resource types
\nIN _count 0..1 integer See discussion below on the utility of paging through the results of the $everything operation
\nOUT return 1..1 Bundle The bundle type is "searchset"
\n
The key differences between this operation and simply searching the patient compartment are:
\n\n- unless the client requests otherwise, the server returns the entire result set in a single bundle (rather than using paging)
\n- the server is responsible for determining what resources to return as included resources (rather than the client specifying which ones).
\n
\nThis frees the client from needing to determine what it could or should ask for, particularly with regard to included resources. Servers should consider returning appropriate Provenance and AuditTrail on the returned resources, even though these are not directly part of the patient compartment.
\nIt is assumed that the server has identified and secured the context appropriately, and can either associate the authorization context with a single patient, or determine whether the context has the rights to the nominated patient, if there is one, or can determine an appropriate list of patients to provide data for from the context of the request. If there is no nominated patient (GET /Patient/$everything) and the context is not associated with a single patient record, the actual list of patients is all patients that the user associated with the request has access to. This may be all patients in the family that the patient has access to, or it may be all patients that a care provider has access to, or all patients on the entire record system. In such cases, the server may choose to return an error rather than all the records. Specifying the relationship between the context, a user and patient records is outside the scope of this specification (though see The Smart App Launch Implementation Guide.
\nWhen this operation is used to access multiple patient records at once, the return bundle could be rather a lot of data; servers may choose to require that such requests are made asynchronously, and associated with bulk data formats. Alternatively, clients may choose to page through the result set (or servers may require this). Paging through the results is done the same as for Searching, using the _count parameter, and Bundle links. Implementers should note that paging will be slower than simply returning all the results at once (more network traffic, multiple latency delays) but may be required in order not to exhaust available memory reading or writing the whole response in a single package. Unlike searching, there is no inherent user-display order for the $everything operation. Servers might consider sorting the returned resources in descending order of last record update, but are not required to do so.
\nThe _since parameter is provided to support periodic queries to get additional information that has changed about the patient since the last query. This means that the _since parameter is based on record time. The value of the _since parameter should be set to the time from the server. If using direct response, this is the timestamp in the response header. If using the async interface, this is the transaction timestamp in the json response. Servers should ensure that the timestamps a managed such that the client does not miss any changes. Clients should be able to handle getting the same response more than once in the case that the transaction falls on a time boundary. Clients should ensure that the other query parameters are constant to ensure a coherent set of records when doing periodic queries.
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/Patient-everything",
"version" : "4.0.0",
"name" : "Fetch Patient Record",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "This operation is used to return all the information related to one or more patients described in the resource or context on which this operation is invoked. The response is a bundle of type \"searchset\". At a minimum, the patient resource(s) itself is returned, along with any other resources that the server has that are related to the patient(s), and that are available for the given user. The server also returns whatever resources are needed to support the records - e.g. linked practitioners, medications, locations, organizations etc. \n\nThe intended use for this operation is to provide a patient with access to their entire record (e.g. \"Blue Button\"), or for provider or other user to perform a bulk data download. The server SHOULD return at least all resources that it has that are in the patient compartment for the identified patient(s), and any resource referenced from those, including binaries and attachments. In the US Realm, at a minimum, the resources returned SHALL include all the data covered by the meaningful use common data elements as defined in the US Core Implementation Guide. Other applicable implementation guides may make additional rules about how much information that is returned.",
"code" : "everything",
"comment" : "The key differences between this operation and simply searching the patient compartment are: \n\n* unless the client requests otherwise, the server returns the entire result set in a single bundle (rather than using paging) \n* the server is responsible for determining what resources to return as included resources (rather than the client specifying which ones). \n\nThis frees the client from needing to determine what it could or should ask for, particularly with regard to included resources. Servers should consider returning appropriate Provenance and AuditTrail on the returned resources, even though these are not directly part of the patient compartment. \n\nIt is assumed that the server has identified and secured the context appropriately, and can either associate the authorization context with a single patient, or determine whether the context has the rights to the nominated patient, if there is one, or can determine an appropriate list of patients to provide data for from the context of the request. If there is no nominated patient (GET /Patient/$everything) and the context is not associated with a single patient record, the actual list of patients is all patients that the user associated with the request has access to. This may be all patients in the family that the patient has access to, or it may be all patients that a care provider has access to, or all patients on the entire record system. In such cases, the server may choose to return an error rather than all the records. Specifying the relationship between the context, a user and patient records is outside the scope of this specification (though see [The Smart App Launch Implementation Guide](http://hl7.org/fhir/smart-app-launch). \n\nWhen this operation is used to access multiple patient records at once, the return bundle could be rather a lot of data; servers may choose to require that such requests are made [asynchronously](async.html), and associated with [bulk data formats](formats.html#bulk). Alternatively, clients may choose to page through the result set (or servers may require this). Paging through the results is done the same as for [Searching](http.html#paging), using the [_count](search.html#count) parameter, and Bundle links. Implementers should note that paging will be slower than simply returning all the results at once (more network traffic, multiple latency delays) but may be required in order not to exhaust available memory reading or writing the whole response in a single package. Unlike searching, there is no inherent user-display order for the $everything operation. Servers might consider sorting the returned resources in descending order of last record update, but are not required to do so.\n\nThe _since parameter is provided to support periodic queries to get additional information that has changed about the patient since the last query. This means that the _since parameter is based on record time. The value of the _since parameter should be set to the time from the server. If using direct response, this is the timestamp in the response header. If using the async interface, this is the transaction timestamp in the json response. Servers should ensure that the timestamps a managed such that the client does not miss any changes. Clients should be able to handle getting the same response more than once in the case that the transaction falls on a time boundary. Clients should ensure that the other query parameters are constant to ensure a coherent set of records when doing periodic queries.",
"resource" : ["Patient"],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [{
"name" : "start",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no start date is provided, all records prior to the end date are in scope.",
"type" : "date"
},
{
"name" : "end",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no end date is provided, all records subsequent to the start date are in scope.",
"type" : "date"
},
{
"name" : "_since",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Resources updated after this period will be included in the response. The intent of this parameter is to allow a client to request only records that have changed since the last request, based on either the return header time, or or (for asynchronous use), the transaction time",
"type" : "instant"
},
{
"name" : "_type",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "One or more parameters, each containing one or more comma-delimited FHIR resource types to include in the return resources. In the absence of any specified types, the server returns all resource types",
"type" : "code"
},
{
"name" : "_count",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "See discussion below on the utility of paging through the results of the $everything operation",
"type" : "integer"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The bundle type is \"searchset\"",
"type" : "Bundle"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/Patient-match",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "Patient-match",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Find patient matches using MPI based logic
OPERATION: Find patient matches using MPI based logic
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Patient-match
A Master Patient Index (MPI ) is a service used to manage patient identification in a context where multiple patient databases exist. Healthcare applications and middleware use the MPI to match patients between the databases, and to store new patient details as they are encountered. MPIs are highly specialized applications, often tailored extensively to the institution's particular mix of patients. MPIs can also be run on a regional and national basis.
\nTo ask an MPI to match a patient, clients use the "$match" operation, which accepts a patient resource which may be only partially complete. The data provided is interpreted as an MPI input and processed by an algorithm of some kind that uses the data to determine the most appropriate matches in the patient set. Note that different MPI matching algorithms have different required inputs. The generic $match operation does not specify any particular algorithm, nor a minimum set of information that must be provided when asking for an MPI match operation to be performed, but many implementations will have a set of minimum information, which may be declared in their definition of the $match operation by specifying a profile on the resource parameter, indicating which properties are required in the search. The patient resource submitted to the operation does not have to be complete, nor does it need to pass validation (i.e. mandatory fields don't need to be populated), but it does have to be a valid instance, as it is used as the reference data to match against.
\nURL: [base]/Patient/$match
Parameters
Use Name Cardinality Type Binding Documentation IN resource 1..1 Resource Use this to provide an entire set of patient details for the MPI to match against (e.g. POST a patient record to Patient/$match).
\nIN onlyCertainMatches 0..1 boolean If there are multiple potential matches, then the match should not return the results with this flag set to true. When false, the server may return multiple results with each result graded accordingly.
\nIN count 0..1 integer The maximum number of records to return. If no value is provided, the server decides how many matches to return. Note that clients should be careful when using this, as it may prevent probable - and valid - matches from being returned
\nOUT return 1..1 Bundle A bundle contain a set of Patient records that represent possible matches, optionally it may also contain an OperationOutcome with further information about the search results (such as warnings or information messages, such as a count of records that were close but eliminated) If the operation was unsuccessful, then an OperationOutcome may be returned along with a BadRequest status Code (e.g. security issue, or insufficient properties in patient fragment - check against profile)
\n
The response from an "mpi" query is a bundle containing patient records, ordered from most likely to least likely. If there are no patient matches, the MPI SHALL return an empty search set with no error, but may include an operation outcome with further advice regarding patient selection. All patient records SHALL have a search score from 0 to 1, where 1 is the most certain match, along with an extension "match-grade" that indicates the MPI's position on the match quality.
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/Patient-match",
"version" : "4.0.0",
"name" : "Find patient matches using MPI based logic",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "A Master Patient Index ([MPI](http://en.wikipedia.org/wiki/Enterprise_master_patient_index) ) is a service used to manage patient identification in a context where multiple patient databases exist. Healthcare applications and middleware use the MPI to match patients between the databases, and to store new patient details as they are encountered. MPIs are highly specialized applications, often tailored extensively to the institution's particular mix of patients. MPIs can also be run on a regional and national basis. \n\nTo ask an MPI to match a patient, clients use the \"$match\" operation, which accepts a patient resource which may be only partially complete. The data provided is interpreted as an MPI input and processed by an algorithm of some kind that uses the data to determine the most appropriate matches in the patient set. Note that different MPI matching algorithms have different required inputs. The generic $match operation does not specify any particular algorithm, nor a minimum set of information that must be provided when asking for an MPI match operation to be performed, but many implementations will have a set of minimum information, which may be declared in their definition of the $match operation by specifying a profile on the resource parameter, indicating which properties are required in the search. The patient resource submitted to the operation does not have to be complete, nor does it need to pass validation (i.e. mandatory fields don't need to be populated), but it does have to be a valid instance, as it is used as the reference data to match against.",
"code" : "match",
"comment" : "The response from an \"mpi\" query is a bundle containing patient records, ordered from most likely to least likely. If there are no patient matches, the MPI SHALL return an empty search set with no error, but may include an operation outcome with further advice regarding patient selection. All patient records SHALL have a search score from 0 to 1, where 1 is the most certain match, along with an extension \"[match-grade](extension-match-grade.html)\" that indicates the MPI's position on the match quality.",
"resource" : ["Patient"],
"system" : false,
"type" : true,
"instance" : false,
"parameter" : [{
"name" : "resource",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Use this to provide an entire set of patient details for the MPI to match against (e.g. POST a patient record to Patient/$match).",
"type" : "Resource"
},
{
"name" : "onlyCertainMatches",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "If there are multiple potential matches, then the match should not return the results with this flag set to true. When false, the server may return multiple results with each result graded accordingly.",
"type" : "boolean"
},
{
"name" : "count",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The maximum number of records to return. If no value is provided, the server decides how many matches to return. Note that clients should be careful when using this, as it may prevent probable - and valid - matches from being returned",
"type" : "integer"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "A bundle contain a set of Patient records that represent possible matches, optionally it may also contain an OperationOutcome with further information about the search results (such as warnings or information messages, such as a count of records that were close but eliminated) If the operation was unsuccessful, then an OperationOutcome may be returned along with a BadRequest status Code (e.g. security issue, or insufficient properties in patient fragment - check against profile)",
"type" : "Bundle"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/PlanDefinition-apply",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "PlanDefinition-apply",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Apply
OPERATION: Apply
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/PlanDefinition-apply
The apply operation applies a PlanDefinition to a given context
\nURL: [base]/PlanDefinition/$apply
URL: [base]/PlanDefinition/[id]/$apply
Parameters
Use Name Cardinality Type Binding Documentation IN planDefinition 0..1 PlanDefinition The plan definition to be applied. If the operation is invoked at the instance level, this parameter is not allowed; if the operation is invoked at the type level, this parameter is required
\nIN subject 1..* string
(reference) The subject(s) that is/are the target of the plan to be applied. The subject may be a Patient, Practitioner, Organization, Location, Device, or Group. Subjects provided in this parameter will be resolved as the subject of the PlanDefinition based on the type of the subject. If multiple subjects of the same type are provided, the behavior is implementation-defined
\nIN encounter 0..1 string
(reference) The encounter in context, if any
\nIN practitioner 0..1 string
(reference) The practitioner applying the plan definition
\nIN organization 0..1 string
(reference) The organization applying the plan definition
\nIN userType 0..1 CodeableConcept The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.)
\nIN userLanguage 0..1 CodeableConcept Preferred language of the person using the system
\nIN userTaskContext 0..1 CodeableConcept The task the system user is performing, e.g. laboratory results review, medication list review, etc. This information can be used to tailor decision support outputs, such as recommended information resources
\nIN setting 0..1 CodeableConcept The current setting of the request (inpatient, outpatient, etc.)
\nIN settingContext 0..1 CodeableConcept Additional detail about the setting of the request, if any
\nOUT return 1..1 CarePlan The CarePlan that is the result of applying the plan definition
\n
The result of this operation is a CarePlan resource with a single activity represented by a RequestGroup. The RequestGroup will have actions for each of the applicable actions in the plan based on evaluating the applicability condition in context. For each applicable action, the definition is applied as described in the $apply operation of the ActivityDefinition resource, and the resulting resource is added as an activity to the CarePlan. If the ActivityDefinition includes library references, those libraries will be available to the evaluated expressions. If those libraries have parameters, those parameters will be bound by name to the parameters given to the operation. In addition, parameters to the $apply operation are available within dynamicValue expressions as context variables, accessible by the name of the parameter, prefixed with a percent (%) symbol. For a more detailed description, refer to the PlanDefinition and ActivityDefinition resource documentation
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/PlanDefinition-apply",
"version" : "4.0.0",
"name" : "Apply",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "The apply operation applies a PlanDefinition to a given context",
"code" : "apply",
"comment" : "The result of this operation is a CarePlan resource with a single activity represented by a RequestGroup. The RequestGroup will have actions for each of the applicable actions in the plan based on evaluating the applicability condition in context. For each applicable action, the definition is applied as described in the $apply operation of the ActivityDefinition resource, and the resulting resource is added as an activity to the CarePlan. If the ActivityDefinition includes library references, those libraries will be available to the evaluated expressions. If those libraries have parameters, those parameters will be bound by name to the parameters given to the operation. In addition, parameters to the $apply operation are available within dynamicValue expressions as context variables, accessible by the name of the parameter, prefixed with a percent (%) symbol. For a more detailed description, refer to the PlanDefinition and ActivityDefinition resource documentation",
"resource" : ["PlanDefinition"],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [{
"name" : "planDefinition",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The plan definition to be applied. If the operation is invoked at the instance level, this parameter is not allowed; if the operation is invoked at the type level, this parameter is required",
"type" : "PlanDefinition"
},
{
"name" : "subject",
"use" : "in",
"min" : 1,
"max" : "*",
"documentation" : "The subject(s) that is/are the target of the plan to be applied. The subject may be a Patient, Practitioner, Organization, Location, Device, or Group. Subjects provided in this parameter will be resolved as the subject of the PlanDefinition based on the type of the subject. If multiple subjects of the same type are provided, the behavior is implementation-defined",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "encounter",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The encounter in context, if any",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "practitioner",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The practitioner applying the plan definition",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "organization",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The organization applying the plan definition",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "userType",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.)",
"type" : "CodeableConcept"
},
{
"name" : "userLanguage",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Preferred language of the person using the system",
"type" : "CodeableConcept"
},
{
"name" : "userTaskContext",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The task the system user is performing, e.g. laboratory results review, medication list review, etc. This information can be used to tailor decision support outputs, such as recommended information resources",
"type" : "CodeableConcept"
},
{
"name" : "setting",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The current setting of the request (inpatient, outpatient, etc.)",
"type" : "CodeableConcept"
},
{
"name" : "settingContext",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Additional detail about the setting of the request, if any",
"type" : "CodeableConcept"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The CarePlan that is the result of applying the plan definition",
"type" : "CarePlan"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/PlanDefinition-data-requirements",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "PlanDefinition-data-requirements",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Data Requirements
OPERATION: Data Requirements
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/PlanDefinition-data-requirements
The data-requirements operation aggregates and returns the parameters and data requirements for the plan definition and all its dependencies as a single module definition library
\nURL: [base]/PlanDefinition/[id]/$data-requirements
Parameters
Use Name Cardinality Type Binding Documentation OUT return 1..1 Library The result of the requirements gathering is a module-definition Library that describes the aggregate parameters, data requirements, and dependencies of the plan definition
\n
The effect of invoking this operation is to determine the aggregate set of data requirements and dependencies for the plan definition. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the plan definition and any libraries referenced by it. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements)
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/PlanDefinition-data-requirements",
"version" : "4.0.0",
"name" : "Data Requirements",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "The data-requirements operation aggregates and returns the parameters and data requirements for the plan definition and all its dependencies as a single module definition library",
"code" : "data-requirements",
"comment" : "The effect of invoking this operation is to determine the aggregate set of data requirements and dependencies for the plan definition. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the plan definition and any libraries referenced by it. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements)",
"resource" : ["PlanDefinition"],
"system" : false,
"type" : false,
"instance" : true,
"parameter" : [{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The result of the requirements gathering is a module-definition Library that describes the aggregate parameters, data requirements, and dependencies of the plan definition",
"type" : "Library"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/Resource-convert",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "Resource-convert",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Convert from one form to another
OPERATION: Convert from one form to another
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Resource-convert
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)
\nURL: [base]/$convert
Parameters
Use Name Cardinality Type Binding Documentation IN input 1..1 Resource The resource that is to be converted
\nOUT output 1..1 Resource The resource after conversion
\n
While the primary use of this operation is simple - converting a resource from one format to another, there are many potential uses including:
\n\n- converting resources from one version to another
\n- restructuring information in a resource (e.g. moving method into/out of Observation.code)
\n- extracting data from a questionnaire
\n- converting CDA documents or v2 messages (as a binary resource) to a bundle (or vice versa) (or even openEHR or openMHealth).
\n
\nThese variants would all be associated with parameters that define and control these kind of conversions, though such parameters are not defined at this time. In the absence of any parameters, simple format conversion is all that will occur.
\nFor this reason, implementers should be aware that:
\n\n- the output resource type may be different from the input resource (particularly, it might be a bundle)
\n- binary resources may be represented directly using some other content-type (i.e. just post the content directly)
\n
\nImplementers are encouraged to provide feedback to HL7 about their use of this operation
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "draft"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/Resource-convert",
"version" : "4.0.0",
"name" : "Convert from one form to another",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "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)",
"code" : "convert",
"comment" : "While the primary use of this operation is simple - converting a resource from one format to another, there are many potential uses including:\n\n* converting resources from one version to another\n* restructuring information in a resource (e.g. moving method into/out of Observation.code)\n* extracting data from a questionnaire\n* converting CDA documents or v2 messages (as a binary resource) to a bundle (or vice versa) (or even openEHR or openMHealth). \n\nThese variants would all be associated with parameters that define and control these kind of conversions, though such parameters are not defined at this time. In the absence of any parameters, simple format conversion is all that will occur.\n\nFor this reason, implementers should be aware that:\n\n* the output resource type may be different from the input resource (particularly, it might be a bundle)\n* binary resources may be represented directly using some other content-type (i.e. just post the content directly)\n\nImplementers are encouraged to provide feedback to HL7 about their use of this operation",
"resource" : ["Resource"],
"system" : true,
"type" : false,
"instance" : false,
"parameter" : [{
"name" : "input",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The resource that is to be converted",
"type" : "Resource"
},
{
"name" : "output",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The resource after conversion",
"type" : "Resource"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/Resource-graph",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "Resource-graph",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Return a graph of resources
OPERATION: Return a graph of resources
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Resource-graph
Return an entire graph of resources based on a GraphDefinition. The operation is invoked on a specific instance of a resource, and the graph definition tells the server what other resources to return in the same packaage
\nURL: [base]/Resource/[id]/$graph
Parameters
Use Name Cardinality Type Binding Documentation IN graph 1..1 uri Servers MAY choose to allow any graph definition to be specified, but MAY require that the client choose a graph definition from a specific list of known supported definitions. The server is not required to support a formal definition of the graph on the end point
\nOUT result 1..1 Bundle The set of resources that were in the graph based on the provided definition
\n
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/Resource-graph",
"version" : "4.0.0",
"name" : "Return a graph of resources",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "Return an entire graph of resources based on a [GraphDefinition](graphdefinition.html). The operation is invoked on a specific instance of a resource, and the graph definition tells the server what other resources to return in the same packaage",
"code" : "graph",
"resource" : ["Resource"],
"system" : false,
"type" : false,
"instance" : true,
"parameter" : [{
"name" : "graph",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Servers MAY choose to allow any graph definition to be specified, but MAY require that the client choose a graph definition from a specific list of known supported definitions. The server is not required to support a formal definition of the graph on the end point",
"type" : "uri"
},
{
"name" : "result",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The set of resources that were in the graph based on the provided definition",
"type" : "Bundle"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/Resource-graphql",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "Resource-graphql",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Execute a graphql statement
OPERATION: Execute a graphql statement
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Resource-graphql
Execute a graphql statement on a since resource or against the entire system. See the Using GraphQL with FHIR page for further details.
\nFor the purposes of graphQL compatibility, this operation can also be invoked using a POST with the graphQL as the body, or a JSON body (see graphQL spec for details)
\nURL: [base]/$graphql
URL: [base]/Resource/[id]/$graphql
Parameters
Use Name Cardinality Type Binding Documentation IN query 1..1 string OUT result 1..1 Binary The content is always returned as application/json; this SHOULD be specified in the Accept header
\n
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/Resource-graphql",
"version" : "4.0.0",
"name" : "Execute a graphql statement",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "Execute a graphql statement on a since resource or against the entire system. See the [Using GraphQL with FHIR](graphql.html) page for further details.\n\nFor the purposes of graphQL compatibility, this operation can also be invoked using a POST with the graphQL as the body, or a JSON body (see [graphQL spec](http://graphql.org/) for details)",
"code" : "graphql",
"resource" : ["Resource"],
"system" : true,
"type" : false,
"instance" : true,
"parameter" : [{
"name" : "query",
"use" : "in",
"min" : 1,
"max" : "1",
"type" : "string"
},
{
"name" : "result",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The content is always returned as application/json; this SHOULD be specified in the Accept header",
"type" : "Binary"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/Resource-meta",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "Resource-meta",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Access a list of profiles, tags, and security labels
OPERATION: Access a list of profiles, tags, and security labels
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Resource-meta
This operation retrieves a summary of the profiles, tags, and security labels for the given scope; e.g. for each scope:
\n\n- system-wide: a list of all profiles, tags and security labels in use by the system
\n- resource-type level: A list of all profiles, tags, and security labels for the resource type
\n- individual resource level: A list of all profiles, tags, and security labels for the current version of the resource. Also, as a special case, this operation (and other meta operations) can be performed on a historical version of a resource)
\n
\nURL: [base]/$meta
URL: [base]/Resource/$meta
URL: [base]/Resource/[id]/$meta
Parameters
Use Name Cardinality Type Binding Documentation OUT return 1..1 Meta The meta returned by the operation
\n
At the system and type levels, the $meta operation is used to get a summary of all the labels that are in use across the system. The principal use for this operation is to support search e.g. what tags can be searched for. At these levels, the meta will not contain versionId, lastUpdated etc. Systems are not obligated to implement the operation at this level (and should return a 4xx error if they don't). At the resource and historical entry level, the $meta operation returns the same meta as would be returned by accessing the resource directly. This can be used to allow a system to get access to the meta-information for the resource without accessing the resource itself, e.g. for security reasons
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/Resource-meta",
"version" : "4.0.0",
"name" : "Access a list of profiles, tags, and security labels",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "This operation retrieves a summary of the profiles, tags, and security labels for the given scope; e.g. for each scope: \n\n* system-wide: a list of all profiles, tags and security labels in use by the system \n* resource-type level: A list of all profiles, tags, and security labels for the resource type \n* individual resource level: A list of all profiles, tags, and security labels for the current version of the resource. Also, as a special case, this operation (and other meta operations) can be performed on a historical version of a resource)",
"code" : "meta",
"comment" : "At the system and type levels, the $meta operation is used to get a summary of all the labels that are in use across the system. The principal use for this operation is to support search e.g. what tags can be searched for. At these levels, the meta will not contain versionId, lastUpdated etc. Systems are not obligated to implement the operation at this level (and should return a 4xx error if they don't). At the resource and historical entry level, the $meta operation returns the same meta as would be returned by accessing the resource directly. This can be used to allow a system to get access to the meta-information for the resource without accessing the resource itself, e.g. for security reasons",
"resource" : ["Resource"],
"system" : true,
"type" : true,
"instance" : true,
"parameter" : [{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The meta returned by the operation",
"type" : "Meta"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/Resource-meta-add",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "Resource-meta-add",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Add profiles, tags, and security labels to a resource
OPERATION: Add profiles, tags, and security labels to a resource
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Resource-meta-add
This operation takes a meta, and adds the profiles, tags, and security labels found in it to the nominated resource
\nURL: [base]/Resource/[id]/$meta-add
Parameters
Use Name Cardinality Type Binding Documentation IN meta 1..1 Meta Profiles, tags, and security labels to add to the existing resource. Note that profiles, tags, and security labels are sets, and duplicates are not created. The identity of a tag or security label is the system+code. When matching existing tags during adding, version and display are ignored. For profiles, matching is based on the full URL
\nOUT return 1..1 Meta Resulting meta for the resource
\n
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/Resource-meta-add",
"version" : "4.0.0",
"name" : "Add profiles, tags, and security labels to a resource",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "This operation takes a meta, and adds the profiles, tags, and security labels found in it to the nominated resource",
"code" : "meta-add",
"resource" : ["Resource"],
"system" : false,
"type" : false,
"instance" : true,
"parameter" : [{
"name" : "meta",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Profiles, tags, and security labels to add to the existing resource. Note that profiles, tags, and security labels are sets, and duplicates are not created. The identity of a tag or security label is the system+code. When matching existing tags during adding, version and display are ignored. For profiles, matching is based on the full URL",
"type" : "Meta"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Resulting meta for the resource",
"type" : "Meta"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/Resource-meta-delete",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "Resource-meta-delete",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Delete profiles, tags, and security labels for a resource
OPERATION: Delete profiles, tags, and security labels for a resource
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Resource-meta-delete
This operation takes a meta, and deletes the profiles, tags, and security labels found in it from the nominated resource
\nURL: [base]/Resource/[id]/$meta-delete
Parameters
Use Name Cardinality Type Binding Documentation IN meta 1..1 Meta Profiles, tags, and security labels to delete from the existing resource. It is not an error if these tags, profiles, and labels do not exist. The identity of a tag or security label is the system+code. When matching existing tags during deletion, version and display are ignored. For profiles, matching is based on the full URL
\nOUT return 1..1 Meta Resulting meta for the resource
\n
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/Resource-meta-delete",
"version" : "4.0.0",
"name" : "Delete profiles, tags, and security labels for a resource",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "This operation takes a meta, and deletes the profiles, tags, and security labels found in it from the nominated resource",
"code" : "meta-delete",
"resource" : ["Resource"],
"system" : false,
"type" : false,
"instance" : true,
"parameter" : [{
"name" : "meta",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Profiles, tags, and security labels to delete from the existing resource. It is not an error if these tags, profiles, and labels do not exist. The identity of a tag or security label is the system+code. When matching existing tags during deletion, version and display are ignored. For profiles, matching is based on the full URL",
"type" : "Meta"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Resulting meta for the resource",
"type" : "Meta"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/Resource-validate",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "Resource-validate",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Validate a resource
OPERATION: Validate a resource
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Resource-validate
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
\nNote that this operation is not the only way to validate resources - see Validating Resources for further information.
\nURL: [base]/Resource/$validate
URL: [base]/Resource/[id]/$validate
Parameters
Use Name Cardinality Type Binding Documentation IN resource 0..1 Resource Must be present unless the mode is "delete"
\nIN mode 0..1 code http://hl7.org/fhir/ValueSet/resource-validation-mode|4.0.0 (Required) Default is 'no action'; (e.g. general validation)
\nIN profile 0..1 uri If this is nominated, then the resource is validated against this specific profile. If a profile is nominated, and the server cannot validate against the nominated profile, it SHALL return an error
\nOUT return 1..1 OperationOutcome If the operation outcome does not list any errors, and a mode was specified, then this is an indication that the operation would be expected to succeed (excepting for transactional integrity issues, see below)
\n
This operation may be used during design and development to validate application design. It can also be used at run-time. One possible use might be that a client asks the server whether a proposed update is valid as the user is editing a dialog and displays an updated error to the user. The operation can be used as part of a light-weight two phase commit protocol but there is no expectation that the server will hold the content of the resource after this operation is used, or that the server guarantees to successfully perform an actual create, update or delete after the validation operation completes.
\nThis operation returns a 200 OK whether or not the resource is valid. A 4xx or 5xx error means that the validation itself could not be performed, and it is unknown whether the resource is valid or not.
\nNote: the correct behaviour of validation with regard to language (especially for Coding.display) is currently undefined, and further development and testing may lead to specific requirements or recommendations in subsequent releases
\nFuture versions of this specifcation may add additional validation parameters. A candidate list is maintained with the FHIR Validator Documentation
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/Resource-validate",
"version" : "4.0.0",
"name" : "Validate a resource",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "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.",
"code" : "validate",
"comment" : "This operation may be used during design and development to validate application design. It can also be used at run-time. One possible use might be that a client asks the server whether a proposed update is valid as the user is editing a dialog and displays an updated error to the user. The operation can be used as part of a light-weight two phase commit protocol but there is no expectation that the server will hold the content of the resource after this operation is used, or that the server guarantees to successfully perform an actual create, update or delete after the validation operation completes.\n\nThis operation returns a 200 OK whether or not the resource is valid. A 4xx or 5xx error means that the validation itself could not be performed, and it is unknown whether the resource is valid or not.\n\nNote: the correct behaviour of validation with regard to language (especially for Coding.display) is currently undefined, and further development and testing may lead to specific requirements or recommendations in subsequent releases\n\nFuture versions of this specifcation may add additional validation parameters. A candidate list is maintained with the [FHIR Validator Documentation](https://confluence.hl7.org/display/FHIR/Using+the+FHIR+Validator)",
"resource" : ["Resource"],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [{
"name" : "resource",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Must be present unless the mode is \"delete\"",
"type" : "Resource"
},
{
"name" : "mode",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Default is 'no action'; (e.g. general validation)",
"type" : "code",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/fhir/ValueSet/resource-validation-mode|4.0.0"
}
},
{
"name" : "profile",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "If this is nominated, then the resource is validated against this specific profile. If a profile is nominated, and the server cannot validate against the nominated profile, it SHALL return an error",
"type" : "uri"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "If the operation outcome does not list any errors, and a mode was specified, then this is an indication that the operation would be expected to succeed (excepting for transactional integrity issues, see below)",
"type" : "OperationOutcome"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/StructureDefinition-questionnaire",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "StructureDefinition-questionnaire",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Build Questionnaire
OPERATION: Build Questionnaire
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/StructureDefinition-questionnaire
Generates a Questionnaire instance based on a specified StructureDefinition, creating questions for each core element or extension element found in the StructureDefinition.
\nIf the operation is not called at the instance level, one of the identifier, profile or url 'in' parameters must be provided. If more than one is specified, servers may raise an error or may resolve with the parameter of their choice. If called at the instance level, these parameters will be ignored. The response will contain a Questionnaire instance based on the specified StructureDefinition and/or an OperationOutcome resource with errors or warnings. Nested groups are used to handle complex structures and data types. If the 'supportedOnly' parameter is set to true, only those elements marked as "must support" will be included.
\nThis operation is intended to enable auto-generation of simple interfaces for arbitrary profiles. The 'questionnaire' approach to data entry has limitations that will make it less optimal than custom-defined interfaces. However, this function may be useful for simple applications or for systems that wish to support "non-core" resources with minimal development effort.
\nURL: [base]/StructureDefinition/$questionnaire
URL: [base]/StructureDefinition/[id]/$questionnaire
Parameters
Use Name Cardinality Type Binding Documentation IN identifier 0..1 canonical A logical identifier (i.e. 'StructureDefinition.identifier''). The server must know the StructureDefinition or be able to retrieve it from other known repositories.
\nIN profile 0..1 string
(token) The StructureDefinition is provided directly as part of the request. Servers may choose not to accept profiles in this fashion
\nIN url 0..1 canonical The StructureDefinition's official URL (i.e. 'StructureDefinition.url'). The server must know the StructureDefinition or be able to retrieve it from other known repositories.
\nIN supportedOnly 0..1 boolean If true, the questionnaire will only include those elements marked as "mustSupport='true'" in the StructureDefinition.
\nOUT return 1..1 Questionnaire The questionnaire form generated based on the StructureDefinition.
\n
Open Issue: Ideally, extensions should be populated in the generated Questionnaire that will support taking QuestionnaireResponse resources generated from the Questionnaire and turning them back into the appropriate resources.
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/StructureDefinition-questionnaire",
"version" : "4.0.0",
"name" : "Build Questionnaire",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "Generates a [Questionnaire](questionnaire.html) instance based on a specified [StructureDefinition](structuredefinition.html), creating questions for each core element or extension element found in the [StructureDefinition](structuredefinition.html). \n\nIf the operation is not called at the instance level, one of the *identifier*, *profile* or *url* 'in' parameters must be provided. If more than one is specified, servers may raise an error or may resolve with the parameter of their choice. If called at the instance level, these parameters will be ignored. The response will contain a [Questionnaire](questionnaire.html) instance based on the specified [StructureDefinition](structuredefinition.html) and/or an [OperationOutcome](operationoutcome.html) resource with errors or warnings. Nested groups are used to handle complex structures and data types. If the 'supportedOnly' parameter is set to true, only those elements marked as \"must support\" will be included. \n\nThis operation is intended to enable auto-generation of simple interfaces for arbitrary profiles. The 'questionnaire' approach to data entry has limitations that will make it less optimal than custom-defined interfaces. However, this function may be useful for simple applications or for systems that wish to support \"non-core\" resources with minimal development effort.",
"code" : "questionnaire",
"comment" : "**Open Issue**: Ideally, extensions should be populated in the generated [Questionnaire](questionnaire.html) that will support taking [QuestionnaireResponse](questionnaireresponse.html) resources generated from the Questionnaire and turning them back into the appropriate resources.",
"resource" : ["StructureDefinition"],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [{
"name" : "identifier",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A logical identifier (i.e. 'StructureDefinition.identifier''). The server must know the StructureDefinition or be able to retrieve it from other known repositories.",
"type" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
},
{
"name" : "profile",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The [StructureDefinition](structuredefinition.html) is provided directly as part of the request. Servers may choose not to accept profiles in this fashion",
"type" : "string",
"searchType" : "token"
},
{
"name" : "url",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The StructureDefinition's official URL (i.e. 'StructureDefinition.url'). The server must know the StructureDefinition or be able to retrieve it from other known repositories.",
"type" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
},
{
"name" : "supportedOnly",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "If true, the questionnaire will only include those elements marked as \"mustSupport='true'\" in the StructureDefinition.",
"type" : "boolean"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The questionnaire form generated based on the StructureDefinition.",
"type" : "Questionnaire"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/StructureDefinition-snapshot",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "StructureDefinition-snapshot",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Generate Snapshot
OPERATION: Generate Snapshot
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/StructureDefinition-snapshot
Generates a StructureDefinition instance with a snapshot, based on a differential in a specified StructureDefinition.
\nIf the operation is not called at the instance level, either definition or url 'in' parameters must be provided. If more than one is specified, servers may raise an error or may resolve with the parameter of their choice. If called at the instance level, these parameters will be ignored.
\nURL: [base]/StructureDefinition/$snapshot
URL: [base]/StructureDefinition/[id]/$snapshot
Parameters
Use Name Cardinality Type Binding Documentation IN definition 0..1 StructureDefinition The StructureDefinition is provided directly as part of the request. Servers may choose not to accept profiles in this fashion
\nIN url 0..1 string
(token) The StructureDefinition's canonical URL (i.e. 'StructureDefinition.url'). The server must know the structure definition, or be able to retrieve it from other known repositories.
\nOUT return 1..1 StructureDefinition The structure definition with a snapshot
\n
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/StructureDefinition-snapshot",
"version" : "4.0.0",
"name" : "Generate Snapshot",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "Generates a [StructureDefinition](structuredefinition.html) instance with a snapshot, based on a differential in a specified [StructureDefinition](structuredefinition.html). \n\nIf the operation is not called at the instance level, either *definition* or *url* 'in' parameters must be provided. If more than one is specified, servers may raise an error or may resolve with the parameter of their choice. If called at the instance level, these parameters will be ignored.",
"code" : "snapshot",
"resource" : ["StructureDefinition"],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [{
"name" : "definition",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The [StructureDefinition](structuredefinition.html) is provided directly as part of the request. Servers may choose not to accept profiles in this fashion",
"type" : "StructureDefinition"
},
{
"name" : "url",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The StructureDefinition's canonical URL (i.e. 'StructureDefinition.url'). The server must know the structure definition, or be able to retrieve it from other known repositories.",
"type" : "string",
"searchType" : "token"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The structure definition with a snapshot",
"type" : "StructureDefinition"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/StructureMap-transform",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "StructureMap-transform",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Model Instance Transformation
OPERATION: Model Instance Transformation
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/StructureMap-transform
The transform operation takes input content, applies a structure map transform, and then returns the output.
\nURL: [base]/StructureMap/$transform
URL: [base]/StructureMap/[id]/$transform
Parameters
Use Name Cardinality Type Binding Documentation IN source 0..1 uri The structure map to apply. This is only needed if the operation is invoked at the resource level. If the $transform operation is invoked on a particular structure map, this will be ignored by the server
\nIN content 1..1 Resource The logical content to transform
\nOUT return 1..1 Resource The result of the transform
\n
The input and return are specified as 'Resources'. In most usage of the $transform operation, either the input or return content is not a valid FHIR resource. In these cases, the return type is actually a Binary resource. For this operation, the Binary resources may be encoded directly, using a mime-type, as shown in the example. Note: this specification does not yet address the means by which the servers may know the correct mime types for the various content involved
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/StructureMap-transform",
"version" : "4.0.0",
"name" : "Model Instance Transformation",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "The transform operation takes input content, applies a structure map transform, and then returns the output.",
"code" : "transform",
"comment" : "The input and return are specified as 'Resources'. In most usage of the $transform operation, either the input or return content is not a valid FHIR resource. In these cases, the return type is actually a [Binary](binary.html) resource. For this operation, the Binary resources may be encoded directly, using a mime-type, as shown in the example. Note: this specification does not yet address the means by which the servers may know the correct mime types for the various content involved",
"resource" : ["StructureMap"],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [{
"name" : "source",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The structure map to apply. This is only needed if the operation is invoked at the resource level. If the $transform operation is invoked on a particular structure map, this will be ignored by the server",
"type" : "uri"
},
{
"name" : "content",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The logical content to transform",
"type" : "Resource"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The result of the transform",
"type" : "Resource"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/ValueSet-expand",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "ValueSet-expand",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Value Set Expansion
OPERATION: Value Set Expansion
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/ValueSet-expand
The definition of a value set is used to create a simple collection of codes suitable for use for data entry or validation.
\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.
\nURL: [base]/ValueSet/$expand
URL: [base]/ValueSet/[id]/$expand
Parameters
Use Name Cardinality Type Binding Documentation IN url 0..1 uri A canonical reference to a value set. The server must know the value set (e.g. it is defined explicitly in the server's value sets, or it is defined implicitly by some code system known to the server
\nIN valueSet 0..1 ValueSet The value set is provided directly as part of the request. Servers may choose not to accept value sets in this fashion
\nIN valueSetVersion 0..1 string The identifier that is used to identify a specific version of the value set to be used when generating the expansion. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available.
\nIN context 0..1 uri The context of the value set, so that the server can resolve this to a value set to expand. The recommended format for this URI is [Structure Definition URL]#[name or path into structure definition] e.g. http://hl7.org/fhir/StructureDefinition/observation-hspc-height-hspcheight#Observation.interpretation. Other forms may be used but are not defined. This form is only usable if the terminology server also has access to the conformance registry that the server is using, but can be used to delegate the mapping from an application context to a binding at run-time
\nIN contextDirection 0..1 code If a context is provided, a context direction may also be provided. Valid values are:
\n\n- 'incoming': the codes a client can use for PUT/POST operations, and
\n- 'outgoing', the codes a client might receive from the server.
\n
\nThe purpose is to inform the server whether to use the value set associated with the context for reading or writing purposes (note: for most elements, this is the same value set, but there are a few elements where the reading and writing value sets are different)
\nIN filter 0..1 string A text filter that is applied to restrict the codes that are returned (this is useful in a UI context). The interpretation of this is delegated to the server in order to allow to determine the most optimal search approach for the context. The server can document the way this parameter works in TerminologyCapabilities..expansion.textFilter. Typical usage of this parameter includes functionality like:
\n\n- using left matching e.g. "acut ast"
\n- allowing for wild cards such as %, &, ?
\n- searching on definition as well as display(s)
\n- allowing for search conditions (and / or / exclusions)
\n
\nText Search engines such as Lucene or Solr, long with their considerable functionality, might also be used. The optional text search might also be code system specific, and servers might have different implementations for different code systems
\nIN date 0..1 dateTime The date for which the expansion should be generated. if a date is provided, it means that the server should use the value set / code system definitions as they were on the given date, or return an error if this is not possible. Normally, the date is the current conditions (which is the default value) but under some circumstances, systems need to generate an expansion as it would have been in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy.
\nIN offset 0..1 integer Paging support - where to start if a subset is desired (default = 0). Offset is number of records (not number of pages)
\nIN count 0..1 integer Paging support - how many codes should be provided in a partial page view. Paging only applies to flat expansions - servers ignore paging if the expansion is not flat. If count = 0, the client is asking how large the expansion is. Servers SHOULD honor this request for hierarchical expansions as well, and simply return the overall count
\nIN includeDesignations 0..1 boolean Controls whether concept designations are to be included or excluded in value set expansions
\nIN designation 0..* string A token that specifies a system+code that is either a use or a language. Designations that match by language or use are included in the expansion. If no designation is specified, it is at the server discretion which designations to return
\nIN includeDefinition 0..1 boolean Controls whether the value set definition is included or excluded in value set expansions
\nIN activeOnly 0..1 boolean Controls whether inactive concepts are included or excluded in value set expansions. Note that if the value set explicitly specifies that inactive codes are included, this parameter can still remove them from a specific expansion, but this parameter cannot include them if the value set excludes them
\nIN excludeNested 0..1 boolean Controls whether or not the value set expansion nests codes or not (i.e. ValueSet.expansion.contains.contains)
\nIN excludeNotForUI 0..1 boolean Controls whether or not the value set expansion is assembled for a user interface use or not. Value sets intended for User Interface might include 'abstract' codes or have nested contains with items with no code or abstract = true, with the sole purpose of helping a user navigate through the list efficiently, where as a value set not generated for UI use might be flat, and only contain the selectable codes in the value set. The exact implications of 'for UI' depend on the code system, and what properties it exposes for a terminology server to use. In the FHIR Specification itself, the value set expansions are generated with excludeNotForUI = false, and the expansions used when generated schema / code etc, or performing validation, are all excludeNotForUI = true.
\nIN excludePostCoordinated 0..1 boolean Controls whether or not the value set expansion includes post coordinated codes
\nIN displayLanguage 0..1 code Specifies the language to be used for description in the expansions i.e. the language to be used for ValueSet.expansion.contains.display
\nIN exclude-system 0..* canonical Code system, or a particular version of a code system to be excluded from the value set expansion. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56
\nIN system-version 0..* canonical Specifies a version to use for a system, if the value set does not specify which one to use. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56
\nIN check-system-version 0..* canonical Edge Case: Specifies a version to use for a system. If a value set specifies a different version, an error is returned instead of the expansion. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56
\nIN force-system-version 0..* canonical Edge Case: Specifies a version to use for a system. This parameter overrides any specified version in the value set (and any it depends on). The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56. Note that this has obvious safety issues, in that it may result in a value set expansion giving a different list of codes that is both wrong and unsafe, and implementers should only use this capability reluctantly. It primarily exists to deal with situations where specifications have fallen into decay as time passes. If the value is override, the version used SHALL explicitly be represented in the expansion parameters
\nOUT return 1..1 ValueSet The result of the expansion. Servers generating expansions SHOULD ensure that all the parameters that affect the contents of the expansion are recorded in the ValueSet.expansion.parameter list
\n
The value set expansion returned by this query should be treated as a transient result that will change over time (whether it does or not depends on how the value set is specified), so applications should repeat the operation each time the value set is used.
\nIf the expansion is too large (at the discretion of the server), the server MAY return an error (OperationOutcome with code too-costly). Clients can work through large flat expansions in a set of pages (partial views of the full expansion) instead of just getting the full expansion in a single exchange by using offset and count parameters, or use the count parameter to request a subset of the expansion for limited purposes. Servers are not obliged to support paging, but if they do, SHALL support both the offset and count parameters. Hierarchical expansions are not subject to paging and servers simply return the entire expansion.
\nDifferent servers may return different results from expanding a value set for the following reasons:
\n\n- The underlying code systems are different (e.g. different versions, possibly with different defined behavior)
\n- The server optimizes filter includes differently, such as sorting by code frequency
\n- Servers introduce arbitrary groups to assist a user to navigate the lists based either on extensions in the definition, or additional knowledge available to the server
\n
\nWhen a server cannot correctly expand a value set because it does not fully understand the code systems (e.g. it has the wrong version, or incomplete definitions) then it SHALL return an error. If the value set itself is unbounded due to the inclusion of post-coordinated value sets (e.g. SNOMED CT, UCUM), then the extension http://hl7.org/fhir/StructureDefinition/valueset-unclosed can be used to indicate that the expansion is incomplete
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/ValueSet-expand",
"version" : "4.0.0",
"name" : "Value Set Expansion",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "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.",
"code" : "expand",
"comment" : "The value set expansion returned by this query should be treated as a transient result that will change over time (whether it does or not depends on how the value set is specified), so applications should repeat the operation each time the value set is used. \n\nIf the expansion is too large (at the discretion of the server), the server MAY return an error (OperationOutcome with code too-costly). Clients can work through large flat expansions in a set of pages (partial views of the full expansion) instead of just getting the full expansion in a single exchange by using offset and count parameters, or use the count parameter to request a subset of the expansion for limited purposes. Servers are not obliged to support paging, but if they do, SHALL support both the offset and count parameters. Hierarchical expansions are not subject to paging and servers simply return the entire expansion. \n\nDifferent servers may return different results from expanding a value set for the following reasons: \n\n* The underlying code systems are different (e.g. different versions, possibly with different defined behavior) \n* The server optimizes filter includes differently, such as sorting by code frequency \n* Servers introduce arbitrary groups to assist a user to navigate the lists based either on extensions in the definition, or additional knowledge available to the server\n\nWhen a server cannot correctly expand a value set because it does not fully understand the code systems (e.g. it has the wrong version, or incomplete definitions) then it SHALL return an error. If the value set itself is unbounded due to the inclusion of post-coordinated value sets (e.g. SNOMED CT, UCUM), then the extension [http://hl7.org/fhir/StructureDefinition/valueset-unclosed](extension-valueset-unclosed.html) can be used to indicate that the expansion is incomplete",
"resource" : ["ValueSet"],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [{
"name" : "url",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A canonical reference to a value set. The server must know the value set (e.g. it is defined explicitly in the server's value sets, or it is defined implicitly by some code system known to the server",
"type" : "uri"
},
{
"name" : "valueSet",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The value set is provided directly as part of the request. Servers may choose not to accept value sets in this fashion",
"type" : "ValueSet"
},
{
"name" : "valueSetVersion",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The identifier that is used to identify a specific version of the value set to be used when generating the expansion. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available.",
"type" : "string"
},
{
"name" : "context",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The context of the value set, so that the server can resolve this to a value set to expand. The recommended format for this URI is [Structure Definition URL]#[name or path into structure definition] e.g. http://hl7.org/fhir/StructureDefinition/observation-hspc-height-hspcheight#Observation.interpretation. Other forms may be used but are not defined. This form is only usable if the terminology server also has access to the conformance registry that the server is using, but can be used to delegate the mapping from an application context to a binding at run-time",
"type" : "uri"
},
{
"name" : "contextDirection",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "If a context is provided, a context direction may also be provided. Valid values are: \n\n* 'incoming': the codes a client can use for PUT/POST operations, and \n* 'outgoing', the codes a client might receive from the server.\n\nThe purpose is to inform the server whether to use the value set associated with the context for reading or writing purposes (note: for most elements, this is the same value set, but there are a few elements where the reading and writing value sets are different)",
"type" : "code"
},
{
"name" : "filter",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A text filter that is applied to restrict the codes that are returned (this is useful in a UI context). The interpretation of this is delegated to the server in order to allow to determine the most optimal search approach for the context. The server can document the way this parameter works in [TerminologyCapabilities](terminologycapabilities.html)..expansion.textFilter. Typical usage of this parameter includes functionality like:\n\n* using left matching e.g. \"acut ast\"\n* allowing for wild cards such as %, &, ?\n* searching on definition as well as display(s)\n* allowing for search conditions (and / or / exclusions)\n\nText Search engines such as Lucene or Solr, long with their considerable functionality, might also be used. The optional text search might also be code system specific, and servers might have different implementations for different code systems",
"type" : "string"
},
{
"name" : "date",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The date for which the expansion should be generated. if a date is provided, it means that the server should use the value set / code system definitions as they were on the given date, or return an error if this is not possible. Normally, the date is the current conditions (which is the default value) but under some circumstances, systems need to generate an expansion as it would have been in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy.",
"type" : "dateTime"
},
{
"name" : "offset",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Paging support - where to start if a subset is desired (default = 0). Offset is number of records (not number of pages)",
"type" : "integer"
},
{
"name" : "count",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Paging support - how many codes should be provided in a partial page view. Paging only applies to flat expansions - servers ignore paging if the expansion is not flat. If count = 0, the client is asking how large the expansion is. Servers SHOULD honor this request for hierarchical expansions as well, and simply return the overall count",
"type" : "integer"
},
{
"name" : "includeDesignations",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Controls whether concept designations are to be included or excluded in value set expansions",
"type" : "boolean"
},
{
"name" : "designation",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "A [token](search.html#token) that specifies a system+code that is either a use or a language. Designations that match by language or use are included in the expansion. If no designation is specified, it is at the server discretion which designations to return",
"type" : "string"
},
{
"name" : "includeDefinition",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Controls whether the value set definition is included or excluded in value set expansions",
"type" : "boolean"
},
{
"name" : "activeOnly",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Controls whether inactive concepts are included or excluded in value set expansions. Note that if the value set explicitly specifies that inactive codes are included, this parameter can still remove them from a specific expansion, but this parameter cannot include them if the value set excludes them",
"type" : "boolean"
},
{
"name" : "excludeNested",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Controls whether or not the value set expansion nests codes or not (i.e. ValueSet.expansion.contains.contains)",
"type" : "boolean"
},
{
"name" : "excludeNotForUI",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Controls whether or not the value set expansion is assembled for a user interface use or not. Value sets intended for User Interface might include ['abstract' codes](codesystem.html#status) or have nested contains with items with no code or abstract = true, with the sole purpose of helping a user navigate through the list efficiently, where as a value set not generated for UI use might be flat, and only contain the selectable codes in the value set. The exact implications of 'for UI' depend on the code system, and what properties it exposes for a terminology server to use. In the FHIR Specification itself, the value set expansions are generated with excludeNotForUI = false, and the expansions used when generated schema / code etc, or performing validation, are all excludeNotForUI = true.",
"type" : "boolean"
},
{
"name" : "excludePostCoordinated",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Controls whether or not the value set expansion includes post coordinated codes",
"type" : "boolean"
},
{
"name" : "displayLanguage",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Specifies the language to be used for description in the expansions i.e. the language to be used for ValueSet.expansion.contains.display",
"type" : "code"
},
{
"name" : "exclude-system",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Code system, or a particular version of a code system to be excluded from the value set expansion. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56",
"type" : "canonical"
},
{
"name" : "system-version",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Specifies a version to use for a system, if the value set does not specify which one to use. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56",
"type" : "canonical"
},
{
"name" : "check-system-version",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Edge Case: Specifies a version to use for a system. If a value set specifies a different version, an error is returned instead of the expansion. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56",
"type" : "canonical"
},
{
"name" : "force-system-version",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Edge Case: Specifies a version to use for a system. This parameter overrides any specified version in the value set (and any it depends on). The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56. Note that this has obvious safety issues, in that it may result in a value set expansion giving a different list of codes that is both wrong and unsafe, and implementers should only use this capability reluctantly. It primarily exists to deal with situations where specifications have fallen into decay as time passes. If the value is override, the version used SHALL explicitly be represented in the expansion parameters",
"type" : "canonical"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The result of the expansion. Servers generating expansions SHOULD ensure that all the parameters that affect the contents of the expansion are recorded in the ValueSet.expansion.parameter list",
"type" : "ValueSet"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code",
"resource" : {
"resourceType" : "OperationDefinition",
"id" : "ValueSet-validate-code",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Value Set based Validation
OPERATION: Value Set based Validation
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code
Validate that a coded value is in the set of codes allowed by a value set.
\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
\nURL: [base]/ValueSet/$validate-code
URL: [base]/ValueSet/[id]/$validate-code
Parameters
Use Name Cardinality Type Binding Documentation IN url 0..1 uri Value set Canonical URL. The server must know the value set (e.g. it is defined explicitly in the server's value sets, or it is defined implicitly by some code system known to the server
\nIN context 0..1 uri The context of the value set, so that the server can resolve this to a value set to validate against. The recommended format for this URI is [Structure Definition URL]#[name or path into structure definition] e.g. http://hl7.org/fhir/StructureDefinition/observation-hspc-height-hspcheight#Observation.interpretation. Other forms may be used but are not defined. This form is only usable if the terminology server also has access to the conformance registry that the server is using, but can be used to delegate the mapping from an application context to a binding at run-time
\nIN valueSet 0..1 ValueSet The value set is provided directly as part of the request. Servers may choose not to accept value sets in this fashion. This parameter is used when the client wants the server to expand a value set that is not stored on the server
\nIN valueSetVersion 0..1 string The identifier that is used to identify a specific version of the value set to be used when validating the code. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available.
\nIN code 0..1 code The code that is to be validated. If a code is provided, a system or a context must be provided (if a context is provided, then the server SHALL ensure that the code is not ambiguous without a system)
\nIN system 0..1 uri The system for the code that is to be validated
\nIN systemVersion 0..1 string The version of the system, if one was provided in the source data
\nIN display 0..1 string The display associated with the code, if provided. If a display is provided a code must be provided. If no display is provided, the server cannot validate the display value, but may choose to return a recommended display name using the display parameter in the outcome. Whether displays are case sensitive is code system dependent
\nIN coding 0..1 Coding A coding to validate
\nIN codeableConcept 0..1 CodeableConcept A full codeableConcept to validate. The server returns true if one of the coding values is in the value set, and may also validate that the codings are not in conflict with each other if more than one is present
\nIN date 0..1 dateTime The date for which the validation should be checked. Normally, this is the current conditions (which is the default values) but under some circumstances, systems need to validate that a correct code was used at some point in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy.
\nIN abstract 0..1 boolean If this parameter has a value of true, the client is stating that the validation is being performed in a context where a concept designated as 'abstract' is appropriate/allowed to be used, and the server should regard abstract codes as valid. If this parameter is false, abstract codes are not considered to be valid.
\nNote that. 'abstract' is a property defined by many HL7 code systems that indicates that the concept is a logical grouping concept that is not intended to be used asa 'concrete' concept to in an actual patient/care/process record. This language is borrowed from Object Orienated theory where 'asbtract' objects are never instantiated. However in the general record and terminology eco-system, there are many contexts where it is appropraite to use these codes e.g. as decision making criterion, or when editing value sets themselves. This parameter allows a client to indicate to the server that it is working in such a context.
\nIN displayLanguage 0..1 code Specifies the language to be used for description when validating the display property
\nOUT result 1..1 boolean True if the concept details supplied are valid
\nOUT message 0..1 string Error details, if result = false. If this is provided when result = true, the message carries hints and warnings
\nOUT display 0..1 string A valid display for the concept if the system wishes to display this to a user
\n
Note: the correct behaviour of validation with regard to language for Coding.display items is currently undefined, and further development and testing may lead to specific requirements or recommendations in subsequent releases
\n"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code",
"version" : "4.0.0",
"name" : "Value Set based Validation",
"status" : "draft",
"kind" : "operation",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "[email protected]"
}]
}],
"description" : "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",
"code" : "validate-code",
"comment" : "Note: the correct behaviour of validation with regard to language for Coding.display items is currently undefined, and further development and testing may lead to specific requirements or recommendations in subsequent releases",
"resource" : ["ValueSet"],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [{
"name" : "url",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Value set Canonical URL. The server must know the value set (e.g. it is defined explicitly in the server's value sets, or it is defined implicitly by some code system known to the server",
"type" : "uri"
},
{
"name" : "context",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The context of the value set, so that the server can resolve this to a value set to validate against. The recommended format for this URI is [Structure Definition URL]#[name or path into structure definition] e.g. http://hl7.org/fhir/StructureDefinition/observation-hspc-height-hspcheight#Observation.interpretation. Other forms may be used but are not defined. This form is only usable if the terminology server also has access to the conformance registry that the server is using, but can be used to delegate the mapping from an application context to a binding at run-time",
"type" : "uri"
},
{
"name" : "valueSet",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The value set is provided directly as part of the request. Servers may choose not to accept value sets in this fashion. This parameter is used when the client wants the server to expand a value set that is not stored on the server",
"type" : "ValueSet"
},
{
"name" : "valueSetVersion",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The identifier that is used to identify a specific version of the value set to be used when validating the code. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available.",
"type" : "string"
},
{
"name" : "code",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The code that is to be validated. If a code is provided, a system or a context must be provided (if a context is provided, then the server SHALL ensure that the code is not ambiguous without a system)",
"type" : "code"
},
{
"name" : "system",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The system for the code that is to be validated",
"type" : "uri"
},
{
"name" : "systemVersion",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The version of the system, if one was provided in the source data",
"type" : "string"
},
{
"name" : "display",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The display associated with the code, if provided. If a display is provided a code must be provided. If no display is provided, the server cannot validate the display value, but may choose to return a recommended display name using the display parameter in the outcome. Whether displays are case sensitive is code system dependent",
"type" : "string"
},
{
"name" : "coding",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A coding to validate",
"type" : "Coding"
},
{
"name" : "codeableConcept",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A full codeableConcept to validate. The server returns true if one of the coding values is in the value set, and may also validate that the codings are not in conflict with each other if more than one is present",
"type" : "CodeableConcept"
},
{
"name" : "date",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The date for which the validation should be checked. Normally, this is the current conditions (which is the default values) but under some circumstances, systems need to validate that a correct code was used at some point in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy.",
"type" : "dateTime"
},
{
"name" : "abstract",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "If this parameter has a value of true, the client is stating that the validation is being performed in a context where a concept designated as 'abstract' is appropriate/allowed to be used, and the server should regard abstract codes as valid. If this parameter is false, abstract codes are not considered to be valid.\n\nNote that. 'abstract' is a property defined by many HL7 code systems that indicates that the concept is a logical grouping concept that is not intended to be used asa 'concrete' concept to in an actual patient/care/process record. This language is borrowed from Object Orienated theory where 'asbtract' objects are never instantiated. However in the general record and terminology eco-system, there are many contexts where it is appropraite to use these codes e.g. as decision making criterion, or when editing value sets themselves. This parameter allows a client to indicate to the server that it is working in such a context.",
"type" : "boolean"
},
{
"name" : "displayLanguage",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Specifies the language to be used for description when validating the display property",
"type" : "code"
},
{
"name" : "result",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "True if the concept details supplied are valid",
"type" : "boolean"
},
{
"name" : "message",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "Error details, if result = false. If this is provided when result = true, the message carries hints and warnings",
"type" : "string"
},
{
"name" : "display",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "A valid display for the concept if the system wishes to display this to a user",
"type" : "string"
}]
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/Resource",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "Resource",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints Resource N n/a Base Resource \r\n id Σ 0..1 id Logical id of this artifact \r\n meta Σ 0..1 Meta Metadata about the resource \r\n implicitRules ?!Σ 0..1 uri A set of rules under which this content was created \r\n language 0..1 code Language of the resource content
Common Languages (Preferred but limited to AllLanguages) \r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Resource",
"version" : "4.0.0",
"name" : "Resource",
"status" : "active",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}]
}],
"description" : "This is the base resource type for everything.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : true,
"type" : "Resource",
"snapshot" : {
"element" : [{
"id" : "Resource",
"path" : "Resource",
"short" : "Base Resource",
"definition" : "This is the base resource type for everything.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Resource",
"min" : 0,
"max" : "*"
},
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
}]
},
{
"id" : "Resource.id",
"path" : "Resource.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Resource.meta",
"path" : "Resource.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Resource.implicitRules",
"path" : "Resource.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Resource.language",
"path" : "Resource.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
}]
},
"differential" : {
"element" : [{
"id" : "Resource",
"path" : "Resource",
"short" : "Base Resource",
"definition" : "This is the base resource type for everything.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
}]
},
{
"id" : "Resource.id",
"path" : "Resource.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "id"
}],
"isSummary" : true
},
{
"id" : "Resource.meta",
"path" : "Resource.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Meta"
}],
"isSummary" : true
},
{
"id" : "Resource.implicitRules",
"path" : "Resource.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Resource.language",
"path" : "Resource.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/Account",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "Account",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints Account TU DomainResource Tracks balance, charges, for patient or cost center
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension \r\n identifier Σ 0..* Identifier Account number
\r\n status ?!Σ 1..1 code active | inactive | entered-in-error | on-hold | unknown
AccountStatus (Required) \r\n type Σ 0..1 CodeableConcept E.g. patient, expense, depreciation
Account Types (Example) \r\n name Σ 0..1 string Human-readable label \r\n subject Σ 0..* Reference(Patient | Device | Practitioner | PractitionerRole | Location | HealthcareService | Organization) The entity that caused the expenses
\r\n servicePeriod Σ 0..1 Period Transaction window \r\n coverage Σ 0..* BackboneElement The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account
\r\n coverage Σ 1..1 Reference(Coverage) The party(s), such as insurances, that may contribute to the payment of this account \r\n priority Σ 0..1 positiveInt The priority of the coverage in the context of this account \r\n owner Σ 0..1 Reference(Organization) Entity managing the Account \r\n description Σ 0..1 string Explanation of purpose/use \r\n guarantor 0..* BackboneElement The parties ultimately responsible for balancing the Account
\r\n party 1..1 Reference(Patient | RelatedPerson | Organization) Responsible entity \r\n onHold 0..1 boolean Credit or other hold applied \r\n period 0..1 Period Guarantee account during \r\n partOf 0..1 Reference(Account) Reference to a parent Account \r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Financial.General"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pa"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Account",
"version" : "4.0.0",
"name" : "Account",
"status" : "draft",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (Patient Administration)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/pafm/index.cfm"
}]
}],
"description" : "A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Account",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Account",
"path" : "Account",
"short" : "Tracks balance, charges, for patient or cost center",
"definition" : "A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.",
"alias" : ["Cost center",
"Record"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Account",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "Account"
}]
},
{
"id" : "Account.id",
"path" : "Account.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Account.meta",
"path" : "Account.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Account.implicitRules",
"path" : "Account.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Account.language",
"path" : "Account.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Account.text",
"path" : "Account.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Account.contained",
"path" : "Account.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Account.extension",
"path" : "Account.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Account.modifierExtension",
"path" : "Account.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Account.identifier",
"path" : "Account.identifier",
"short" : "Account number",
"definition" : "Unique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Account.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Account.status",
"path" : "Account.status",
"short" : "active | inactive | entered-in-error | on-hold | unknown",
"definition" : "Indicates whether the account is presently used/usable or not.",
"comment" : "This element is labeled as a modifier because the status contains the codes inactive and entered-in-error that mark the Account as not currently valid.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Account.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AccountStatus"
}],
"strength" : "required",
"description" : "Indicates whether the account is available to be used.",
"valueSet" : "http://hl7.org/fhir/ValueSet/account-status|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "Account.type",
"path" : "Account.type",
"short" : "E.g. patient, expense, depreciation",
"definition" : "Categorizes the account for reporting and searching purposes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Account.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AccountType"
}],
"strength" : "example",
"description" : "The usage type of this account, permits categorization of accounts.",
"valueSet" : "http://hl7.org/fhir/ValueSet/account-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "Account.name",
"path" : "Account.name",
"short" : "Human-readable label",
"definition" : "Name used for the account when displaying it to humans in reports, etc.",
"alias" : ["Title"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Account.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".title"
}]
},
{
"id" : "Account.subject",
"path" : "Account.subject",
"short" : "The entity that caused the expenses",
"definition" : "Identifies the entity which incurs the expenses. While the immediate recipients of services or goods might be entities related to the subject, the expenses were ultimately incurred by the subject of the Account.",
"comment" : "Accounts can be applied to non-patients for tracking other non-patient related activities, such as group services (patients not tracked, and costs charged to another body), or might not be allocated.",
"alias" : ["target"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Account.subject",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Location",
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "rim",
"map" : ".subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Account.servicePeriod",
"path" : "Account.servicePeriod",
"short" : "Transaction window",
"definition" : "The date range of services associated with this account.",
"comment" : "It is possible for transactions to be posted outside the service period, as long as the service was provided within the defined service period.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Account.servicePeriod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "rim",
"map" : ".coverage.insurancePolicy.effectiveTime"
}]
},
{
"id" : "Account.coverage",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Coverage"
}],
"path" : "Account.coverage",
"short" : "The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account",
"definition" : "The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.",
"comment" : "Typically. this may be some form of insurance, internal charges, or self-pay.\n\nLocal or jurisdictional business rules may determine which coverage covers which types of billable items charged to the account, and in which order.\nWhere the order is important, a local/jurisdictional extension may be defined to specify the order for the type of charge.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Account.coverage",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".coverage"
}]
},
{
"id" : "Account.coverage.id",
"path" : "Account.coverage.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Account.coverage.extension",
"path" : "Account.coverage.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Account.coverage.modifierExtension",
"path" : "Account.coverage.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Account.coverage.coverage",
"path" : "Account.coverage.coverage",
"short" : "The party(s), such as insurances, that may contribute to the payment of this account",
"definition" : "The party(s) that contribute to payment (or part of) of the charges applied to this account (including self-pay).\n\nA coverage may only be responsible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Account.coverage.coverage",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Coverage"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".coverage.insurancePolicy.author"
}]
},
{
"id" : "Account.coverage.priority",
"path" : "Account.coverage.priority",
"short" : "The priority of the coverage in the context of this account",
"definition" : "The priority of the coverage in the context of this account.",
"comment" : "It is common in some jurisdictions for there to be multiple coverages allocated to an account, and a sequence is required to order the settling of the account (often with insurance claiming).",
"alias" : ["coordination of benefit priority"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Account.coverage.priority",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".coverage.sequenceNumber"
}]
},
{
"id" : "Account.owner",
"path" : "Account.owner",
"short" : "Entity managing the Account",
"definition" : "Indicates the service area, hospital, department, etc. with responsibility for managing the Account.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Account.owner",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".holder"
}]
},
{
"id" : "Account.description",
"path" : "Account.description",
"short" : "Explanation of purpose/use",
"definition" : "Provides additional information about what the account tracks and how it is used.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Account.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".subjectOf.observationEvent[code=\"annotation\"].value"
}]
},
{
"id" : "Account.guarantor",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Guarantor"
}],
"path" : "Account.guarantor",
"short" : "The parties ultimately responsible for balancing the Account",
"definition" : "The parties responsible for balancing the account if other payment options fall short.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Account.guarantor",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".holder.guarantorRole"
}]
},
{
"id" : "Account.guarantor.id",
"path" : "Account.guarantor.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Account.guarantor.extension",
"path" : "Account.guarantor.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Account.guarantor.modifierExtension",
"path" : "Account.guarantor.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Account.guarantor.party",
"path" : "Account.guarantor.party",
"short" : "Responsible entity",
"definition" : "The entity who is responsible.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Account.guarantor.party",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".holder.guarantorRole[guarantorPerson|guarantorOrganization]"
}]
},
{
"id" : "Account.guarantor.onHold",
"path" : "Account.guarantor.onHold",
"short" : "Credit or other hold applied",
"definition" : "A guarantor may be placed on credit hold or otherwise have their role temporarily suspended.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Account.guarantor.onHold",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".holder.guarantorRole.statusCode"
}]
},
{
"id" : "Account.guarantor.period",
"path" : "Account.guarantor.period",
"short" : "Guarantee account during",
"definition" : "The timeframe during which the guarantor accepts responsibility for the account.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Account.guarantor.period",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".holder.guarantorRole.effectiveTime"
}]
},
{
"id" : "Account.partOf",
"path" : "Account.partOf",
"short" : "Reference to a parent Account",
"definition" : "Reference to a parent Account.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Account.partOf",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Account"]
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "Account",
"path" : "Account",
"short" : "Tracks balance, charges, for patient or cost center",
"definition" : "A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.",
"alias" : ["Cost center",
"Record"],
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "rim",
"map" : "Account"
}]
},
{
"id" : "Account.identifier",
"path" : "Account.identifier",
"short" : "Account number",
"definition" : "Unique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Account.status",
"path" : "Account.status",
"short" : "active | inactive | entered-in-error | on-hold | unknown",
"definition" : "Indicates whether the account is presently used/usable or not.",
"comment" : "This element is labeled as a modifier because the status contains the codes inactive and entered-in-error that mark the Account as not currently valid.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AccountStatus"
}],
"strength" : "required",
"description" : "Indicates whether the account is available to be used.",
"valueSet" : "http://hl7.org/fhir/ValueSet/account-status|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "Account.type",
"path" : "Account.type",
"short" : "E.g. patient, expense, depreciation",
"definition" : "Categorizes the account for reporting and searching purposes.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AccountType"
}],
"strength" : "example",
"description" : "The usage type of this account, permits categorization of accounts.",
"valueSet" : "http://hl7.org/fhir/ValueSet/account-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "Account.name",
"path" : "Account.name",
"short" : "Human-readable label",
"definition" : "Name used for the account when displaying it to humans in reports, etc.",
"alias" : ["Title"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".title"
}]
},
{
"id" : "Account.subject",
"path" : "Account.subject",
"short" : "The entity that caused the expenses",
"definition" : "Identifies the entity which incurs the expenses. While the immediate recipients of services or goods might be entities related to the subject, the expenses were ultimately incurred by the subject of the Account.",
"comment" : "Accounts can be applied to non-patients for tracking other non-patient related activities, such as group services (patients not tracked, and costs charged to another body), or might not be allocated.",
"alias" : ["target"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Location",
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "rim",
"map" : ".subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Account.servicePeriod",
"path" : "Account.servicePeriod",
"short" : "Transaction window",
"definition" : "The date range of services associated with this account.",
"comment" : "It is possible for transactions to be posted outside the service period, as long as the service was provided within the defined service period.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "rim",
"map" : ".coverage.insurancePolicy.effectiveTime"
}]
},
{
"id" : "Account.coverage",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Coverage"
}],
"path" : "Account.coverage",
"short" : "The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account",
"definition" : "The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.",
"comment" : "Typically. this may be some form of insurance, internal charges, or self-pay.\n\nLocal or jurisdictional business rules may determine which coverage covers which types of billable items charged to the account, and in which order.\nWhere the order is important, a local/jurisdictional extension may be defined to specify the order for the type of charge.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".coverage"
}]
},
{
"id" : "Account.coverage.coverage",
"path" : "Account.coverage.coverage",
"short" : "The party(s), such as insurances, that may contribute to the payment of this account",
"definition" : "The party(s) that contribute to payment (or part of) of the charges applied to this account (including self-pay).\n\nA coverage may only be responsible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Coverage"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".coverage.insurancePolicy.author"
}]
},
{
"id" : "Account.coverage.priority",
"path" : "Account.coverage.priority",
"short" : "The priority of the coverage in the context of this account",
"definition" : "The priority of the coverage in the context of this account.",
"comment" : "It is common in some jurisdictions for there to be multiple coverages allocated to an account, and a sequence is required to order the settling of the account (often with insurance claiming).",
"alias" : ["coordination of benefit priority"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".coverage.sequenceNumber"
}]
},
{
"id" : "Account.owner",
"path" : "Account.owner",
"short" : "Entity managing the Account",
"definition" : "Indicates the service area, hospital, department, etc. with responsibility for managing the Account.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".holder"
}]
},
{
"id" : "Account.description",
"path" : "Account.description",
"short" : "Explanation of purpose/use",
"definition" : "Provides additional information about what the account tracks and how it is used.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".subjectOf.observationEvent[code=\"annotation\"].value"
}]
},
{
"id" : "Account.guarantor",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Guarantor"
}],
"path" : "Account.guarantor",
"short" : "The parties ultimately responsible for balancing the Account",
"definition" : "The parties responsible for balancing the account if other payment options fall short.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".holder.guarantorRole"
}]
},
{
"id" : "Account.guarantor.party",
"path" : "Account.guarantor.party",
"short" : "Responsible entity",
"definition" : "The entity who is responsible.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".holder.guarantorRole[guarantorPerson|guarantorOrganization]"
}]
},
{
"id" : "Account.guarantor.onHold",
"path" : "Account.guarantor.onHold",
"short" : "Credit or other hold applied",
"definition" : "A guarantor may be placed on credit hold or otherwise have their role temporarily suspended.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".holder.guarantorRole.statusCode"
}]
},
{
"id" : "Account.guarantor.period",
"path" : "Account.guarantor.period",
"short" : "Guarantee account during",
"definition" : "The timeframe during which the guarantor accepts responsibility for the account.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".holder.guarantorRole.effectiveTime"
}]
},
{
"id" : "Account.partOf",
"path" : "Account.partOf",
"short" : "Reference to a parent Account",
"definition" : "Reference to a parent Account.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Account"]
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "ActivityDefinition",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints ActivityDefinition ITU DomainResource The definition of a specific activity to be taken, independent of any particular patient or context
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension \r\n url Σ 0..1 uri Canonical identifier for this activity definition, represented as a URI (globally unique) \r\n identifier Σ 0..* Identifier Additional identifier for the activity definition
\r\n version Σ 0..1 string Business version of the activity definition \r\n name ΣI 0..1 string Name for this activity definition (computer friendly) \r\n title Σ 0..1 string Name for this activity definition (human friendly) \r\n subtitle 0..1 string Subordinate title of the activity definition \r\n status ?!Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required) \r\n experimental Σ 0..1 boolean For testing purposes, not real usage \r\n subject[x] 0..1 Type of individual the activity definition is intended for
Subject type (Extensible) \r\n subjectCodeableConcept CodeableConcept \r\n subjectReference Reference(Group) \r\n date Σ 0..1 dateTime Date last changed \r\n publisher Σ 0..1 string Name of the publisher (organization or individual) \r\n contact Σ 0..* ContactDetail Contact details for the publisher
\r\n description Σ 0..1 markdown Natural language description of the activity definition \r\n useContext Σ 0..* UsageContext The context that the content is intended to support
\r\n jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for activity definition (if applicable)
Jurisdiction (Extensible)
\r\n purpose 0..1 markdown Why this activity definition is defined \r\n usage 0..1 string Describes the clinical usage of the activity definition \r\n copyright 0..1 markdown Use and/or publishing restrictions \r\n approvalDate 0..1 date When the activity definition was approved by publisher \r\n lastReviewDate 0..1 date When the activity definition was last reviewed \r\n effectivePeriod Σ 0..1 Period When the activity definition is expected to be used \r\n topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
DefinitionTopic (Example)
\r\n author 0..* ContactDetail Who authored the content
\r\n editor 0..* ContactDetail Who edited the content
\r\n reviewer 0..* ContactDetail Who reviewed the content
\r\n endorser 0..* ContactDetail Who endorsed the content
\r\n relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
\r\n library 0..* canonical(Library) Logic used by the activity definition
\r\n kind Σ 0..1 code Kind of resource
RequestResourceType (Required) \r\n profile 0..1 canonical(StructureDefinition) What profile the resource needs to conform to \r\n code Σ 0..1 CodeableConcept Detail type of activity
Procedure Codes (SNOMED CT) (Example) \r\n intent 0..1 code proposal | plan | order
RequestIntent (Required) \r\n priority 0..1 code routine | urgent | asap | stat
Request priority (Required) \r\n doNotPerform ?!Σ 0..1 boolean True if the activity should not be performed \r\n timing[x] 0..1 When activity is to occur \r\n timingTiming Timing \r\n timingDateTime dateTime \r\n timingAge Age \r\n timingPeriod Period \r\n timingRange Range \r\n timingDuration Duration \r\n location 0..1 Reference(Location) Where it should happen \r\n participant 0..* BackboneElement Who should participate in the action
\r\n type 1..1 code patient | practitioner | related-person | device
ActionParticipantType (Required) \r\n role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.
Action participant role (Example) \r\n product[x] 0..1 What's administered/supplied
SNOMED CT Medication Codes (Example) \r\n productReference Reference(Medication | Substance) \r\n productCodeableConcept CodeableConcept \r\n quantity 0..1 SimpleQuantity How much is administered/consumed/supplied \r\n dosage 0..* Dosage Detailed dosage instructions
\r\n bodySite 0..* CodeableConcept What part of body to perform on
SNOMED CT Body Structures (Example)
\r\n specimenRequirement 0..* Reference(SpecimenDefinition) What specimens are required to perform this action
\r\n observationRequirement 0..* Reference(ObservationDefinition) What observations are required to perform this action
\r\n observationResultRequirement 0..* Reference(ObservationDefinition) What observations must be produced by this action
\r\n transform 0..1 canonical(StructureMap) Transform to apply the template \r\n dynamicValue 0..* BackboneElement Dynamic aspects of the definition
\r\n path 1..1 string The path to the element to be set dynamically \r\n expression 1..1 Expression An expression that provides the dynamic value for the customization \r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Definitional Artifacts"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cds"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"version" : "4.0.0",
"name" : "ActivityDefinition",
"status" : "draft",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (Clinical Decision Support)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/dss/index.cfm"
}]
}],
"description" : "This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "objimpl",
"uri" : "http://hl7.org/fhir/object-implementation",
"name" : "Object Implementation Information"
}],
"kind" : "resource",
"abstract" : false,
"type" : "ActivityDefinition",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString" : "MetadataResource"
}]
},
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "ActivityDefinition",
"path" : "ActivityDefinition",
"short" : "The definition of a specific activity to be taken, independent of any particular patient or context",
"definition" : "This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ActivityDefinition",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
},
{
"key" : "adf-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Definition"
},
{
"identity" : "rim",
"map" : "Act[classCode=ACT; moodCode=DEFN]"
}]
},
{
"id" : "ActivityDefinition.id",
"path" : "ActivityDefinition.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ActivityDefinition.meta",
"path" : "ActivityDefinition.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ActivityDefinition.implicitRules",
"path" : "ActivityDefinition.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "ActivityDefinition.language",
"path" : "ActivityDefinition.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "ActivityDefinition.text",
"path" : "ActivityDefinition.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "ActivityDefinition.contained",
"path" : "ActivityDefinition.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ActivityDefinition.extension",
"path" : "ActivityDefinition.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ActivityDefinition.modifierExtension",
"path" : "ActivityDefinition.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ActivityDefinition.url",
"path" : "ActivityDefinition.url",
"short" : "Canonical identifier for this activity definition, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the activity definition to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.url",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".identifier[scope=BUSN;reliability=ISS]"
}]
},
{
"id" : "ActivityDefinition.identifier",
"path" : "ActivityDefinition.identifier",
"short" : "Additional identifier for the activity definition",
"definition" : "A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this activity definition outside of FHIR, where it is not possible to use the logical URI.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ActivityDefinition.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".identifier"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ActivityDefinition.version",
"path" : "ActivityDefinition.version",
"short" : "Business version of the activity definition",
"definition" : "The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.",
"comment" : "There may be different activity definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the activity definition with the format [url]|[version].",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
},
{
"identity" : "rim",
"map" : "N/A (to add?)"
}]
},
{
"id" : "ActivityDefinition.name",
"path" : "ActivityDefinition.name",
"short" : "Name for this activity definition (computer friendly)",
"definition" : "A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ActivityDefinition.title",
"path" : "ActivityDefinition.title",
"short" : "Name for this activity definition (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the activity definition.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
},
{
"identity" : "rim",
"map" : ".title"
}]
},
{
"id" : "ActivityDefinition.subtitle",
"path" : "ActivityDefinition.subtitle",
"short" : "Subordinate title of the activity definition",
"definition" : "An explanatory or alternate title for the activity definition giving additional information about its content.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.subtitle",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ActivityDefinition.status",
"path" : "ActivityDefinition.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this activity definition. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of activity definitions that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status {different ValueSet}"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".status"
}]
},
{
"id" : "ActivityDefinition.experimental",
"path" : "ActivityDefinition.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of activity definitions that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level activity definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.experimental",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : "N/A (to add?)"
}]
},
{
"id" : "ActivityDefinition.subject[x]",
"path" : "ActivityDefinition.subject[x]",
"short" : "Type of individual the activity definition is intended for",
"definition" : "A code or group definition that describes the intended subject of the activity being defined.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.subject[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Group"]
}],
"meaningWhenMissing" : "Patient",
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubjectType"
}],
"strength" : "extensible",
"description" : "The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).",
"valueSet" : "http://hl7.org/fhir/ValueSet/subject-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.subject"
}]
},
{
"id" : "ActivityDefinition.date",
"path" : "ActivityDefinition.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the activity definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the activity definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].time"
}]
},
{
"id" : "ActivityDefinition.publisher",
"path" : "ActivityDefinition.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the activity definition.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the activity definition is the organization or individual primarily responsible for the maintenance and upkeep of the activity definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the activity definition. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the activity definition. May also allow for contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher {as string instead of CodeableConcept}"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
}]
},
{
"id" : "ActivityDefinition.contact",
"path" : "ActivityDefinition.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ActivityDefinition.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=CALLBCK].role"
}]
},
{
"id" : "ActivityDefinition.description",
"path" : "ActivityDefinition.description",
"short" : "Natural language description of the activity definition",
"definition" : "A free text natural language description of the activity definition from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the activity definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the activity definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the activity definition is presumed to be the predominant language in the place the activity definition was created).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
},
{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "ActivityDefinition.useContext",
"path" : "ActivityDefinition.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate activity definition instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ActivityDefinition.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
},
{
"identity" : "rim",
"map" : "N/A (to add?)"
}]
},
{
"id" : "ActivityDefinition.jurisdiction",
"path" : "ActivityDefinition.jurisdiction",
"short" : "Intended jurisdiction for activity definition (if applicable)",
"definition" : "A legal or geographic region in which the activity definition is intended to be used.",
"comment" : "It may be possible for the activity definition to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ActivityDefinition.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
},
{
"identity" : "rim",
"map" : "N/A (to add?)"
}]
},
{
"id" : "ActivityDefinition.purpose",
"path" : "ActivityDefinition.purpose",
"short" : "Why this activity definition is defined",
"definition" : "Explanation of why this activity definition is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the activity definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this activity definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.purpose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".reasonCode.text"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ActivityDefinition.usage",
"path" : "ActivityDefinition.usage",
"short" : "Describes the clinical usage of the activity definition",
"definition" : "A detailed description of how the activity definition is used from a clinical perspective.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.usage",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A (to add?)"
}]
},
{
"id" : "ActivityDefinition.copyright",
"path" : "ActivityDefinition.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the activity definition and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.copyright",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "rim",
"map" : "N/A (to add?)"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ActivityDefinition.approvalDate",
"path" : "ActivityDefinition.approvalDate",
"short" : "When the activity definition was approved by publisher",
"definition" : "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comment" : "The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.approvalDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.approvalDate"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"SUBJ\"].act[classCode=CACT;moodCode=EVN;code=\"approval\"].effectiveTime"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ActivityDefinition.lastReviewDate",
"path" : "ActivityDefinition.lastReviewDate",
"short" : "When the activity definition was last reviewed",
"definition" : "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"comment" : "If specified, this date follows the original approval date.",
"requirements" : "Gives a sense of how \"current\" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.lastReviewDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.lastReviewDate"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"SUBJ\"; subsetCode=\"RECENT\"].act[classCode=CACT;moodCode=EVN;code=\"review\"].effectiveTime"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ActivityDefinition.effectivePeriod",
"path" : "ActivityDefinition.effectivePeriod",
"short" : "When the activity definition is expected to be used",
"definition" : "The period during which the activity definition content was or is planned to be in active use.",
"comment" : "The effective period for a activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.",
"requirements" : "Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the activity definition are or are expected to be used instead.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.effectivePeriod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.effectivePeriod"
},
{
"identity" : "rim",
"map" : "N/A (to add?)"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ActivityDefinition.topic",
"path" : "ActivityDefinition.topic",
"short" : "E.g. Education, Treatment, Assessment, etc.",
"definition" : "Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.",
"requirements" : "Repositories must be able to determine how to categorize the activity definition so that it can be found by topical searches.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ActivityDefinition.topic",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DefinitionTopic"
}],
"strength" : "example",
"description" : "High-level categorization of the definition, used for searching, sorting, and filtering.",
"valueSet" : "http://hl7.org/fhir/ValueSet/definition-topic"
},
"mapping" : [{
"identity" : "rim",
"map" : "N/A (to add?)"
}]
},
{
"id" : "ActivityDefinition.author",
"path" : "ActivityDefinition.author",
"short" : "Who authored the content",
"definition" : "An individiual or organization primarily involved in the creation and maintenance of the content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ActivityDefinition.author",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=AUT]"
}]
},
{
"id" : "ActivityDefinition.editor",
"path" : "ActivityDefinition.editor",
"short" : "Who edited the content",
"definition" : "An individual or organization primarily responsible for internal coherence of the content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ActivityDefinition.editor",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ActivityDefinition.reviewer",
"path" : "ActivityDefinition.reviewer",
"short" : "Who reviewed the content",
"definition" : "An individual or organization primarily responsible for review of some aspect of the content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ActivityDefinition.reviewer",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}"
}]
},
{
"id" : "ActivityDefinition.endorser",
"path" : "ActivityDefinition.endorser",
"short" : "Who endorsed the content",
"definition" : "An individual or organization responsible for officially endorsing the content for use in some setting.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ActivityDefinition.endorser",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}"
}]
},
{
"id" : "ActivityDefinition.relatedArtifact",
"path" : "ActivityDefinition.relatedArtifact",
"short" : "Additional documentation, citations, etc.",
"definition" : "Related artifacts such as additional documentation, justification, or bibliographic references.",
"comment" : "Each related artifact is either an attachment, or a reference to another resource, but not both.",
"requirements" : "Activity definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ActivityDefinition.relatedArtifact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "RelatedArtifact"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DOC,RSON,PREV, DRIV, USE, COMP] {successor would be PREV w/ inversionInd=true; No support for citation}"
}]
},
{
"id" : "ActivityDefinition.library",
"path" : "ActivityDefinition.library",
"short" : "Logic used by the activity definition",
"definition" : "A reference to a Library resource containing any formal logic used by the activity definition.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ActivityDefinition.library",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Library"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=USE].target[classCode=GROUPER,moodCode=EVN]"
}]
},
{
"id" : "ActivityDefinition.kind",
"path" : "ActivityDefinition.kind",
"short" : "Kind of resource",
"definition" : "A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.",
"comment" : "May determine what types of extensions are permitted.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.kind",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActivityDefinitionKind"
}],
"strength" : "required",
"description" : "The kind of activity the definition is describing.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-resource-types|4.0.0"
},
"mapping" : [{
"identity" : "rim",
"map" : ".classCode"
}]
},
{
"id" : "ActivityDefinition.profile",
"path" : "ActivityDefinition.profile",
"short" : "What profile the resource needs to conform to",
"definition" : "A profile to which the target of the activity definition is expected to conform.",
"requirements" : "Allows profiles to be used to describe the types of activities that can be performed within a workflow, protocol, or order set.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.profile",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ActivityDefinition.code",
"path" : "ActivityDefinition.code",
"short" : "Detail type of activity",
"definition" : "Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.",
"comment" : "Tends to be less relevant for activities involving particular products.",
"requirements" : "Allows matching performed to planned as well as validation against protocols.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.code",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActivityDefinitionType"
}],
"strength" : "example",
"description" : "Detailed type of the activity; e.g. CBC.",
"valueSet" : "http://hl7.org/fhir/ValueSet/procedure-code"
},
"mapping" : [{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "ActivityDefinition.intent",
"path" : "ActivityDefinition.intent",
"short" : "proposal | plan | order",
"definition" : "Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.intent",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RequestIntent"
}],
"strength" : "required",
"description" : "Codes indicating the degree of authority/intentionality associated with a request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-intent|4.0.0"
}
},
{
"id" : "ActivityDefinition.priority",
"path" : "ActivityDefinition.priority",
"short" : "routine | urgent | asap | stat",
"definition" : "Indicates how quickly the activity should be addressed with respect to other requests.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.priority",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RequestPriority"
}],
"strength" : "required",
"description" : "Identifies the level of importance to be assigned to actioning the request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-priority|4.0.0"
}
},
{
"id" : "ActivityDefinition.doNotPerform",
"path" : "ActivityDefinition.doNotPerform",
"short" : "True if the activity should not be performed",
"definition" : "Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.",
"comment" : "This element is not intended to be used to communicate a decision support response to cancel an order in progress. That should be done with the \"remove\" type of a PlanDefinition or RequestGroup.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.doNotPerform",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : true,
"isModifierReason" : "If true this element negates the specified action. For Example, instead of a request for a procedure, it is a request for the procedure to not occur.",
"isSummary" : true
},
{
"id" : "ActivityDefinition.timing[x]",
"path" : "ActivityDefinition.timing[x]",
"short" : "When activity is to occur",
"definition" : "The period, timing or frequency upon which the described activity is to occur.",
"requirements" : "Allows prompting for activities and detection of missed planned activities.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.timing[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Timing"
},
{
"code" : "dateTime"
},
{
"code" : "Age"
},
{
"code" : "Period"
},
{
"code" : "Range"
},
{
"code" : "Duration"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "ActivityDefinition.location",
"path" : "ActivityDefinition.location",
"short" : "Where it should happen",
"definition" : "Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.",
"comment" : "May reference a specific clinical location or may just identify a type of location.",
"requirements" : "Helps in planning of activity.",
"alias" : ["facility"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.location",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=LOC].role"
}]
},
{
"id" : "ActivityDefinition.participant",
"path" : "ActivityDefinition.participant",
"short" : "Who should participate in the action",
"definition" : "Indicates who should participate in performing the action described.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ActivityDefinition.participant",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=PFM]"
}]
},
{
"id" : "ActivityDefinition.participant.id",
"path" : "ActivityDefinition.participant.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ActivityDefinition.participant.extension",
"path" : "ActivityDefinition.participant.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ActivityDefinition.participant.modifierExtension",
"path" : "ActivityDefinition.participant.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ActivityDefinition.participant.type",
"path" : "ActivityDefinition.participant.type",
"short" : "patient | practitioner | related-person | device",
"definition" : "The type of participant in the action.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.participant.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActivityParticipantType"
}],
"strength" : "required",
"description" : "The type of participant in the activity.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-participant-type|4.0.0"
},
"mapping" : [{
"identity" : "rim",
"map" : ".role.classCode"
}]
},
{
"id" : "ActivityDefinition.participant.role",
"path" : "ActivityDefinition.participant.role",
"short" : "E.g. Nurse, Surgeon, Parent, etc.",
"definition" : "The role the participant should play in performing the described action.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.participant.role",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActivityParticipantRole"
}],
"strength" : "example",
"description" : "Defines roles played by participants for the action.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-participant-role"
},
"mapping" : [{
"identity" : "rim",
"map" : ".role.code"
}]
},
{
"id" : "ActivityDefinition.product[x]",
"path" : "ActivityDefinition.product[x]",
"short" : "What's administered/supplied",
"definition" : "Identifies the food, drug or other product being consumed or supplied in the activity.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.product[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Substance"]
},
{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActivityProduct"
}],
"strength" : "example",
"description" : "Code describing the type of substance or medication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-codes"
},
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=CSM].role"
}]
},
{
"id" : "ActivityDefinition.quantity",
"path" : "ActivityDefinition.quantity",
"short" : "How much is administered/consumed/supplied",
"definition" : "Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).",
"alias" : ["dose"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".quantity {for classCode=SPLY}"
}]
},
{
"id" : "ActivityDefinition.dosage",
"path" : "ActivityDefinition.dosage",
"short" : "Detailed dosage instructions",
"definition" : "Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.",
"comment" : "If a dosage instruction is used, the definition should not specify timing or quantity.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ActivityDefinition.dosage",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Dosage"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=SBADM; moodCode=DEFN]"
}]
},
{
"id" : "ActivityDefinition.bodySite",
"path" : "ActivityDefinition.bodySite",
"short" : "What part of body to perform on",
"definition" : "Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).",
"comment" : "Only used if not implicit in the code found in ServiceRequest.type.",
"requirements" : "Knowing where the procedure is made is important for tracking if multiple sites are possible.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ActivityDefinition.bodySite",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BodySite"
}],
"strength" : "example",
"description" : "A code that identifies the anatomical location.",
"valueSet" : "http://hl7.org/fhir/ValueSet/body-site"
},
"mapping" : [{
"identity" : "rim",
"map" : ".targetSiteCode {for classCode=PROC, SBADM}"
}]
},
{
"id" : "ActivityDefinition.specimenRequirement",
"path" : "ActivityDefinition.specimenRequirement",
"short" : "What specimens are required to perform this action",
"definition" : "Defines specimen requirements for the action to be performed, such as required specimens for a lab test.",
"requirements" : "Needed to represent lab order definitions.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ActivityDefinition.specimenRequirement",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SpecimenDefinition"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ActivityDefinition.observationRequirement",
"path" : "ActivityDefinition.observationRequirement",
"short" : "What observations are required to perform this action",
"definition" : "Defines observation requirements for the action to be performed, such as body weight or surface area.",
"requirements" : "Needed to represent observation definitions.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ActivityDefinition.observationRequirement",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ActivityDefinition.observationResultRequirement",
"path" : "ActivityDefinition.observationResultRequirement",
"short" : "What observations must be produced by this action",
"definition" : "Defines the observations that are expected to be produced by the action.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ActivityDefinition.observationResultRequirement",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ActivityDefinition.transform",
"path" : "ActivityDefinition.transform",
"short" : "Transform to apply the template",
"definition" : "A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.",
"comment" : "Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.transform",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureMap"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ActivityDefinition.dynamicValue",
"path" : "ActivityDefinition.dynamicValue",
"short" : "Dynamic aspects of the definition",
"definition" : "Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.",
"comment" : "Dynamic values are applied in the order in which they are defined in the ActivityDefinition. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ActivityDefinition.dynamicValue",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ActivityDefinition.dynamicValue.id",
"path" : "ActivityDefinition.dynamicValue.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ActivityDefinition.dynamicValue.extension",
"path" : "ActivityDefinition.dynamicValue.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ActivityDefinition.dynamicValue.modifierExtension",
"path" : "ActivityDefinition.dynamicValue.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ActivityDefinition.dynamicValue.path",
"path" : "ActivityDefinition.dynamicValue.path",
"short" : "The path to the element to be set dynamically",
"definition" : "The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).",
"comment" : "The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.dynamicValue.path",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ActivityDefinition.dynamicValue.expression",
"path" : "ActivityDefinition.dynamicValue.expression",
"short" : "An expression that provides the dynamic value for the customization",
"definition" : "An expression specifying the value of the customized element.",
"comment" : "The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ActivityDefinition.dynamicValue.expression",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Expression"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
}]
},
"differential" : {
"element" : [{
"id" : "ActivityDefinition",
"path" : "ActivityDefinition",
"short" : "The definition of a specific activity to be taken, independent of any particular patient or context",
"definition" : "This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "adf-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition"
},
{
"identity" : "rim",
"map" : "Act[classCode=ACT; moodCode=DEFN]"
}]
},
{
"id" : "ActivityDefinition.url",
"path" : "ActivityDefinition.url",
"short" : "Canonical identifier for this activity definition, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the activity definition to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".identifier[scope=BUSN;reliability=ISS]"
}]
},
{
"id" : "ActivityDefinition.identifier",
"path" : "ActivityDefinition.identifier",
"short" : "Additional identifier for the activity definition",
"definition" : "A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this activity definition outside of FHIR, where it is not possible to use the logical URI.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".identifier"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ActivityDefinition.version",
"path" : "ActivityDefinition.version",
"short" : "Business version of the activity definition",
"definition" : "The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.",
"comment" : "There may be different activity definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the activity definition with the format [url]|[version].",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
},
{
"identity" : "rim",
"map" : "N/A (to add?)"
}]
},
{
"id" : "ActivityDefinition.name",
"path" : "ActivityDefinition.name",
"short" : "Name for this activity definition (computer friendly)",
"definition" : "A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ActivityDefinition.title",
"path" : "ActivityDefinition.title",
"short" : "Name for this activity definition (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the activity definition.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
},
{
"identity" : "rim",
"map" : ".title"
}]
},
{
"id" : "ActivityDefinition.subtitle",
"path" : "ActivityDefinition.subtitle",
"short" : "Subordinate title of the activity definition",
"definition" : "An explanatory or alternate title for the activity definition giving additional information about its content.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "ActivityDefinition.status",
"path" : "ActivityDefinition.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this activity definition. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of activity definitions that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status {different ValueSet}"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".status"
}]
},
{
"id" : "ActivityDefinition.experimental",
"path" : "ActivityDefinition.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of activity definitions that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level activity definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : "N/A (to add?)"
}]
},
{
"id" : "ActivityDefinition.subject[x]",
"path" : "ActivityDefinition.subject[x]",
"short" : "Type of individual the activity definition is intended for",
"definition" : "A code or group definition that describes the intended subject of the activity being defined.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Group"]
}],
"meaningWhenMissing" : "Patient",
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubjectType"
}],
"strength" : "extensible",
"description" : "The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).",
"valueSet" : "http://hl7.org/fhir/ValueSet/subject-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.subject"
}]
},
{
"id" : "ActivityDefinition.date",
"path" : "ActivityDefinition.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the activity definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the activity definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].time"
}]
},
{
"id" : "ActivityDefinition.publisher",
"path" : "ActivityDefinition.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the activity definition.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the activity definition is the organization or individual primarily responsible for the maintenance and upkeep of the activity definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the activity definition. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the activity definition. May also allow for contact.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher {as string instead of CodeableConcept}"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
}]
},
{
"id" : "ActivityDefinition.contact",
"path" : "ActivityDefinition.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=CALLBCK].role"
}]
},
{
"id" : "ActivityDefinition.description",
"path" : "ActivityDefinition.description",
"short" : "Natural language description of the activity definition",
"definition" : "A free text natural language description of the activity definition from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the activity definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the activity definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the activity definition is presumed to be the predominant language in the place the activity definition was created).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
},
{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "ActivityDefinition.useContext",
"path" : "ActivityDefinition.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate activity definition instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
},
{
"identity" : "rim",
"map" : "N/A (to add?)"
}]
},
{
"id" : "ActivityDefinition.jurisdiction",
"path" : "ActivityDefinition.jurisdiction",
"short" : "Intended jurisdiction for activity definition (if applicable)",
"definition" : "A legal or geographic region in which the activity definition is intended to be used.",
"comment" : "It may be possible for the activity definition to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
},
{
"identity" : "rim",
"map" : "N/A (to add?)"
}]
},
{
"id" : "ActivityDefinition.purpose",
"path" : "ActivityDefinition.purpose",
"short" : "Why this activity definition is defined",
"definition" : "Explanation of why this activity definition is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the activity definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this activity definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".reasonCode.text"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ActivityDefinition.usage",
"path" : "ActivityDefinition.usage",
"short" : "Describes the clinical usage of the activity definition",
"definition" : "A detailed description of how the activity definition is used from a clinical perspective.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "rim",
"map" : "N/A (to add?)"
}]
},
{
"id" : "ActivityDefinition.copyright",
"path" : "ActivityDefinition.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the activity definition and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "rim",
"map" : "N/A (to add?)"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ActivityDefinition.approvalDate",
"path" : "ActivityDefinition.approvalDate",
"short" : "When the activity definition was approved by publisher",
"definition" : "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comment" : "The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.approvalDate"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"SUBJ\"].act[classCode=CACT;moodCode=EVN;code=\"approval\"].effectiveTime"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ActivityDefinition.lastReviewDate",
"path" : "ActivityDefinition.lastReviewDate",
"short" : "When the activity definition was last reviewed",
"definition" : "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"comment" : "If specified, this date follows the original approval date.",
"requirements" : "Gives a sense of how \"current\" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.lastReviewDate"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"SUBJ\"; subsetCode=\"RECENT\"].act[classCode=CACT;moodCode=EVN;code=\"review\"].effectiveTime"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ActivityDefinition.effectivePeriod",
"path" : "ActivityDefinition.effectivePeriod",
"short" : "When the activity definition is expected to be used",
"definition" : "The period during which the activity definition content was or is planned to be in active use.",
"comment" : "The effective period for a activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.",
"requirements" : "Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the activity definition are or are expected to be used instead.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.effectivePeriod"
},
{
"identity" : "rim",
"map" : "N/A (to add?)"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ActivityDefinition.topic",
"path" : "ActivityDefinition.topic",
"short" : "E.g. Education, Treatment, Assessment, etc.",
"definition" : "Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.",
"requirements" : "Repositories must be able to determine how to categorize the activity definition so that it can be found by topical searches.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DefinitionTopic"
}],
"strength" : "example",
"description" : "High-level categorization of the definition, used for searching, sorting, and filtering.",
"valueSet" : "http://hl7.org/fhir/ValueSet/definition-topic"
},
"mapping" : [{
"identity" : "rim",
"map" : "N/A (to add?)"
}]
},
{
"id" : "ActivityDefinition.author",
"path" : "ActivityDefinition.author",
"short" : "Who authored the content",
"definition" : "An individiual or organization primarily involved in the creation and maintenance of the content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=AUT]"
}]
},
{
"id" : "ActivityDefinition.editor",
"path" : "ActivityDefinition.editor",
"short" : "Who edited the content",
"definition" : "An individual or organization primarily responsible for internal coherence of the content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}]
},
{
"id" : "ActivityDefinition.reviewer",
"path" : "ActivityDefinition.reviewer",
"short" : "Who reviewed the content",
"definition" : "An individual or organization primarily responsible for review of some aspect of the content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}"
}]
},
{
"id" : "ActivityDefinition.endorser",
"path" : "ActivityDefinition.endorser",
"short" : "Who endorsed the content",
"definition" : "An individual or organization responsible for officially endorsing the content for use in some setting.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}"
}]
},
{
"id" : "ActivityDefinition.relatedArtifact",
"path" : "ActivityDefinition.relatedArtifact",
"short" : "Additional documentation, citations, etc.",
"definition" : "Related artifacts such as additional documentation, justification, or bibliographic references.",
"comment" : "Each related artifact is either an attachment, or a reference to another resource, but not both.",
"requirements" : "Activity definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "RelatedArtifact"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DOC,RSON,PREV, DRIV, USE, COMP] {successor would be PREV w/ inversionInd=true; No support for citation}"
}]
},
{
"id" : "ActivityDefinition.library",
"path" : "ActivityDefinition.library",
"short" : "Logic used by the activity definition",
"definition" : "A reference to a Library resource containing any formal logic used by the activity definition.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Library"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=USE].target[classCode=GROUPER,moodCode=EVN]"
}]
},
{
"id" : "ActivityDefinition.kind",
"path" : "ActivityDefinition.kind",
"short" : "Kind of resource",
"definition" : "A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.",
"comment" : "May determine what types of extensions are permitted.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActivityDefinitionKind"
}],
"strength" : "required",
"description" : "The kind of activity the definition is describing.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-resource-types|4.0.0"
},
"mapping" : [{
"identity" : "rim",
"map" : ".classCode"
}]
},
{
"id" : "ActivityDefinition.profile",
"path" : "ActivityDefinition.profile",
"short" : "What profile the resource needs to conform to",
"definition" : "A profile to which the target of the activity definition is expected to conform.",
"requirements" : "Allows profiles to be used to describe the types of activities that can be performed within a workflow, protocol, or order set.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}]
},
{
"id" : "ActivityDefinition.code",
"path" : "ActivityDefinition.code",
"short" : "Detail type of activity",
"definition" : "Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.",
"comment" : "Tends to be less relevant for activities involving particular products.",
"requirements" : "Allows matching performed to planned as well as validation against protocols.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActivityDefinitionType"
}],
"strength" : "example",
"description" : "Detailed type of the activity; e.g. CBC.",
"valueSet" : "http://hl7.org/fhir/ValueSet/procedure-code"
},
"mapping" : [{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "ActivityDefinition.intent",
"path" : "ActivityDefinition.intent",
"short" : "proposal | plan | order",
"definition" : "Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RequestIntent"
}],
"strength" : "required",
"description" : "Codes indicating the degree of authority/intentionality associated with a request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-intent|4.0.0"
}
},
{
"id" : "ActivityDefinition.priority",
"path" : "ActivityDefinition.priority",
"short" : "routine | urgent | asap | stat",
"definition" : "Indicates how quickly the activity should be addressed with respect to other requests.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RequestPriority"
}],
"strength" : "required",
"description" : "Identifies the level of importance to be assigned to actioning the request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-priority|4.0.0"
}
},
{
"id" : "ActivityDefinition.doNotPerform",
"path" : "ActivityDefinition.doNotPerform",
"short" : "True if the activity should not be performed",
"definition" : "Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.",
"comment" : "This element is not intended to be used to communicate a decision support response to cancel an order in progress. That should be done with the \"remove\" type of a PlanDefinition or RequestGroup.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isModifier" : true,
"isModifierReason" : "If true this element negates the specified action. For Example, instead of a request for a procedure, it is a request for the procedure to not occur.",
"isSummary" : true
},
{
"id" : "ActivityDefinition.timing[x]",
"path" : "ActivityDefinition.timing[x]",
"short" : "When activity is to occur",
"definition" : "The period, timing or frequency upon which the described activity is to occur.",
"requirements" : "Allows prompting for activities and detection of missed planned activities.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Timing"
},
{
"code" : "dateTime"
},
{
"code" : "Age"
},
{
"code" : "Period"
},
{
"code" : "Range"
},
{
"code" : "Duration"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "ActivityDefinition.location",
"path" : "ActivityDefinition.location",
"short" : "Where it should happen",
"definition" : "Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.",
"comment" : "May reference a specific clinical location or may just identify a type of location.",
"requirements" : "Helps in planning of activity.",
"alias" : ["facility"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=LOC].role"
}]
},
{
"id" : "ActivityDefinition.participant",
"path" : "ActivityDefinition.participant",
"short" : "Who should participate in the action",
"definition" : "Indicates who should participate in performing the action described.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=PFM]"
}]
},
{
"id" : "ActivityDefinition.participant.type",
"path" : "ActivityDefinition.participant.type",
"short" : "patient | practitioner | related-person | device",
"definition" : "The type of participant in the action.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActivityParticipantType"
}],
"strength" : "required",
"description" : "The type of participant in the activity.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-participant-type|4.0.0"
},
"mapping" : [{
"identity" : "rim",
"map" : ".role.classCode"
}]
},
{
"id" : "ActivityDefinition.participant.role",
"path" : "ActivityDefinition.participant.role",
"short" : "E.g. Nurse, Surgeon, Parent, etc.",
"definition" : "The role the participant should play in performing the described action.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActivityParticipantRole"
}],
"strength" : "example",
"description" : "Defines roles played by participants for the action.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-participant-role"
},
"mapping" : [{
"identity" : "rim",
"map" : ".role.code"
}]
},
{
"id" : "ActivityDefinition.product[x]",
"path" : "ActivityDefinition.product[x]",
"short" : "What's administered/supplied",
"definition" : "Identifies the food, drug or other product being consumed or supplied in the activity.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Substance"]
},
{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActivityProduct"
}],
"strength" : "example",
"description" : "Code describing the type of substance or medication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-codes"
},
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=CSM].role"
}]
},
{
"id" : "ActivityDefinition.quantity",
"path" : "ActivityDefinition.quantity",
"short" : "How much is administered/consumed/supplied",
"definition" : "Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).",
"alias" : ["dose"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".quantity {for classCode=SPLY}"
}]
},
{
"id" : "ActivityDefinition.dosage",
"path" : "ActivityDefinition.dosage",
"short" : "Detailed dosage instructions",
"definition" : "Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.",
"comment" : "If a dosage instruction is used, the definition should not specify timing or quantity.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Dosage"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=SBADM; moodCode=DEFN]"
}]
},
{
"id" : "ActivityDefinition.bodySite",
"path" : "ActivityDefinition.bodySite",
"short" : "What part of body to perform on",
"definition" : "Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).",
"comment" : "Only used if not implicit in the code found in ServiceRequest.type.",
"requirements" : "Knowing where the procedure is made is important for tracking if multiple sites are possible.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BodySite"
}],
"strength" : "example",
"description" : "A code that identifies the anatomical location.",
"valueSet" : "http://hl7.org/fhir/ValueSet/body-site"
},
"mapping" : [{
"identity" : "rim",
"map" : ".targetSiteCode {for classCode=PROC, SBADM}"
}]
},
{
"id" : "ActivityDefinition.specimenRequirement",
"path" : "ActivityDefinition.specimenRequirement",
"short" : "What specimens are required to perform this action",
"definition" : "Defines specimen requirements for the action to be performed, such as required specimens for a lab test.",
"requirements" : "Needed to represent lab order definitions.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SpecimenDefinition"]
}]
},
{
"id" : "ActivityDefinition.observationRequirement",
"path" : "ActivityDefinition.observationRequirement",
"short" : "What observations are required to perform this action",
"definition" : "Defines observation requirements for the action to be performed, such as body weight or surface area.",
"requirements" : "Needed to represent observation definitions.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"]
}]
},
{
"id" : "ActivityDefinition.observationResultRequirement",
"path" : "ActivityDefinition.observationResultRequirement",
"short" : "What observations must be produced by this action",
"definition" : "Defines the observations that are expected to be produced by the action.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"]
}]
},
{
"id" : "ActivityDefinition.transform",
"path" : "ActivityDefinition.transform",
"short" : "Transform to apply the template",
"definition" : "A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.",
"comment" : "Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureMap"]
}],
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ActivityDefinition.dynamicValue",
"path" : "ActivityDefinition.dynamicValue",
"short" : "Dynamic aspects of the definition",
"definition" : "Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.",
"comment" : "Dynamic values are applied in the order in which they are defined in the ActivityDefinition. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ActivityDefinition.dynamicValue.path",
"path" : "ActivityDefinition.dynamicValue.path",
"short" : "The path to the element to be set dynamically",
"definition" : "The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).",
"comment" : "The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ActivityDefinition.dynamicValue.expression",
"path" : "ActivityDefinition.dynamicValue.expression",
"short" : "An expression that provides the dynamic value for the customization",
"definition" : "An expression specifying the value of the customized element.",
"comment" : "The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Expression"
}],
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/AdverseEvent",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "AdverseEvent",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints AdverseEvent ΣTU DomainResource Medical care, research study or other healthcare event causing physical injury
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension \r\n identifier Σ 0..1 Identifier Business identifier for the event \r\n actuality ?!Σ 1..1 code actual | potential
AdverseEventActuality (Required) \r\n category Σ 0..* CodeableConcept 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
AdverseEventCategory (Extensible)
\r\n event Σ 0..1 CodeableConcept Type of the event itself in relation to the subject
SNOMED CT Clinical Findings (Example) \r\n subject Σ 1..1 Reference(Patient | Group | Practitioner | RelatedPerson) Subject impacted by event \r\n encounter Σ 0..1 Reference(Encounter) Encounter created as part of \r\n date Σ 0..1 dateTime When the event occurred \r\n detected Σ 0..1 dateTime When the event was detected \r\n recordedDate Σ 0..1 dateTime When the event was recorded \r\n resultingCondition Σ 0..* Reference(Condition) Effect on the subject due to this event
\r\n location Σ 0..1 Reference(Location) Location where adverse event occurred \r\n seriousness Σ 0..1 CodeableConcept Seriousness of the event
AdverseEventSeriousness (Example) \r\n severity Σ 0..1 CodeableConcept mild | moderate | severe
AdverseEventSeverity (Required) \r\n outcome Σ 0..1 CodeableConcept resolved | recovering | ongoing | resolvedWithSequelae | fatal | unknown
AdverseEventOutcome (Required) \r\n recorder Σ 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) Who recorded the adverse event \r\n contributor Σ 0..* Reference(Practitioner | PractitionerRole | Device) Who was involved in the adverse event or the potential adverse event
\r\n suspectEntity Σ 0..* BackboneElement The suspected agent causing the adverse event
\r\n instance Σ 1..1 Reference(Immunization | Procedure | Substance | Medication | MedicationAdministration | MedicationStatement | Device) Refers to the specific entity that caused the adverse event \r\n causality Σ 0..* BackboneElement Information on the possible cause of the event
\r\n assessment Σ 0..1 CodeableConcept Assessment of if the entity caused the event
AdverseEventCausalityAssessment (Example) \r\n productRelatedness Σ 0..1 string AdverseEvent.suspectEntity.causalityProductRelatedness \r\n author Σ 0..1 Reference(Practitioner | PractitionerRole) AdverseEvent.suspectEntity.causalityAuthor \r\n method Σ 0..1 CodeableConcept ProbabilityScale | Bayesian | Checklist
AdverseEventCausalityMethod (Example) \r\n subjectMedicalHistory Σ 0..* Reference(Condition | Observation | AllergyIntolerance | FamilyMemberHistory | Immunization | Procedure | Media | DocumentReference) AdverseEvent.subjectMedicalHistory
\r\n referenceDocument Σ 0..* Reference(DocumentReference) AdverseEvent.referenceDocument
\r\n study Σ 0..* Reference(ResearchStudy) AdverseEvent.study
\r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Summary"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pc"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/AdverseEvent",
"version" : "4.0.0",
"name" : "AdverseEvent",
"status" : "draft",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (Patient Care)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}]
}],
"description" : "Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "AdverseEvent",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "AdverseEvent",
"path" : "AdverseEvent",
"short" : "Medical care, research study or other healthcare event causing physical injury",
"definition" : "Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.",
"alias" : ["AE"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "AdverseEvent",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
}]
},
{
"id" : "AdverseEvent.id",
"path" : "AdverseEvent.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "AdverseEvent.meta",
"path" : "AdverseEvent.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "AdverseEvent.implicitRules",
"path" : "AdverseEvent.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "AdverseEvent.language",
"path" : "AdverseEvent.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "AdverseEvent.text",
"path" : "AdverseEvent.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "AdverseEvent.contained",
"path" : "AdverseEvent.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "AdverseEvent.extension",
"path" : "AdverseEvent.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "AdverseEvent.modifierExtension",
"path" : "AdverseEvent.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "AdverseEvent.identifier",
"path" : "AdverseEvent.identifier",
"short" : "Business identifier for the event",
"definition" : "Business identifiers assigned to this adverse event by the performer or other systems which remain constant as the resource is updated and propagates from server to server.",
"comment" : "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"requirements" : "Allows identification of the adverse event as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AdverseEvent.identifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "AdverseEvent.actuality",
"path" : "AdverseEvent.actuality",
"short" : "actual | potential",
"definition" : "Whether the event actually happened, or just had the potential to. Note that this is independent of whether anyone was affected or harmed or how severely.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AdverseEvent.actuality",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it has a potential code that indicates the adverse event did not actually happen.",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdverseEventActuality"
}],
"strength" : "required",
"description" : "Overall nature of the adverse event, e.g. real or potential.",
"valueSet" : "http://hl7.org/fhir/ValueSet/adverse-event-actuality|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "AdverseEvent.category",
"path" : "AdverseEvent.category",
"short" : "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",
"definition" : "The overall type of event, intended for search and filtering purposes.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AdverseEvent.category",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdverseEventCategory"
}],
"strength" : "extensible",
"description" : "Overall categorization of the event, e.g. product-related or situational.",
"valueSet" : "http://hl7.org/fhir/ValueSet/adverse-event-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "AdverseEvent.event",
"path" : "AdverseEvent.event",
"short" : "Type of the event itself in relation to the subject",
"definition" : "This element defines the specific type of event that occurred or that was prevented from occurring.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AdverseEvent.event",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdverseEventType"
}],
"strength" : "example",
"description" : "Detailed type of event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/adverse-event-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
}]
},
{
"id" : "AdverseEvent.subject",
"path" : "AdverseEvent.subject",
"short" : "Subject impacted by event",
"definition" : "This subject or group impacted by the event.",
"comment" : "If AdverseEvent.resultingCondition differs among members of the group, then use Patient as the subject.",
"requirements" : "Allows for exposure of biohazard (such as legionella) to a group of individuals in a hospital.",
"alias" : ["patient"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "AdverseEvent.subject",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.who"
}]
},
{
"id" : "AdverseEvent.encounter",
"path" : "AdverseEvent.encounter",
"short" : "Encounter created as part of",
"definition" : "The Encounter during which AdverseEvent was created or to which the creation of this record is tightly associated.",
"comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. For example, if a medication administration was considered an adverse event because it resulted in a rash, then the encounter when the medication administration was given is the context. If the patient reports the AdverseEvent during a second encounter, that second encounter is not the context.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AdverseEvent.encounter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
}]
},
{
"id" : "AdverseEvent.date",
"path" : "AdverseEvent.date",
"short" : "When the event occurred",
"definition" : "The date (and perhaps time) when the adverse event occurred.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AdverseEvent.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.init"
}]
},
{
"id" : "AdverseEvent.detected",
"path" : "AdverseEvent.detected",
"short" : "When the event was detected",
"definition" : "Estimated or actual date the AdverseEvent began, in the opinion of the reporter.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AdverseEvent.detected",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "AdverseEvent.recordedDate",
"path" : "AdverseEvent.recordedDate",
"short" : "When the event was recorded",
"definition" : "The date on which the existence of the AdverseEvent was first recorded.",
"comment" : "The recordedDate represents the date when this particular AdverseEvent record was created in the system, not the date of the most recent update. The date of the last record modification can be retrieved from the resource metadata.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AdverseEvent.recordedDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "AdverseEvent.resultingCondition",
"path" : "AdverseEvent.resultingCondition",
"short" : "Effect on the subject due to this event",
"definition" : "Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AdverseEvent.resultingCondition",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition"]
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "AdverseEvent.location",
"path" : "AdverseEvent.location",
"short" : "Location where adverse event occurred",
"definition" : "The information about where the adverse event occurred.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AdverseEvent.location",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "AdverseEvent.seriousness",
"path" : "AdverseEvent.seriousness",
"short" : "Seriousness of the event",
"definition" : "Assessment whether this event was of real importance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AdverseEvent.seriousness",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdverseEventSeriousness"
}],
"strength" : "example",
"description" : "Overall seriousness of this event for the patient.",
"valueSet" : "http://hl7.org/fhir/ValueSet/adverse-event-seriousness"
}
},
{
"id" : "AdverseEvent.severity",
"path" : "AdverseEvent.severity",
"short" : "mild | moderate | severe",
"definition" : "Describes the severity of the adverse event, in relation to the subject. Contrast to AdverseEvent.seriousness - a severe rash might not be serious, but a mild heart problem is.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AdverseEvent.severity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdverseEventSeverity"
}],
"strength" : "required",
"description" : "The severity of the adverse event itself, in direct relation to the subject.",
"valueSet" : "http://hl7.org/fhir/ValueSet/adverse-event-severity|4.0.0"
}
},
{
"id" : "AdverseEvent.outcome",
"path" : "AdverseEvent.outcome",
"short" : "resolved | recovering | ongoing | resolvedWithSequelae | fatal | unknown",
"definition" : "Describes the type of outcome from the adverse event.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AdverseEvent.outcome",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdverseEventOutcome"
}],
"strength" : "required",
"description" : "TODO (and should this be required?).",
"valueSet" : "http://hl7.org/fhir/ValueSet/adverse-event-outcome|4.0.0"
}
},
{
"id" : "AdverseEvent.recorder",
"path" : "AdverseEvent.recorder",
"short" : "Who recorded the adverse event",
"definition" : "Information on who recorded the adverse event. May be the patient or a practitioner.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AdverseEvent.recorder",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.author"
}]
},
{
"id" : "AdverseEvent.contributor",
"path" : "AdverseEvent.contributor",
"short" : "Who was involved in the adverse event or the potential adverse event",
"definition" : "Parties that may or should contribute or have contributed information to the adverse event, which can consist of one or more activities. Such information includes information leading to the decision to perform the activity and how to perform the activity (e.g. consultant), information that the activity itself seeks to reveal (e.g. informant of clinical history), or information about what activity was performed (e.g. informant witness).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AdverseEvent.contributor",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "AdverseEvent.suspectEntity",
"path" : "AdverseEvent.suspectEntity",
"short" : "The suspected agent causing the adverse event",
"definition" : "Describes the entity that is suspected to have caused the adverse event.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AdverseEvent.suspectEntity",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "AdverseEvent.suspectEntity.id",
"path" : "AdverseEvent.suspectEntity.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "AdverseEvent.suspectEntity.extension",
"path" : "AdverseEvent.suspectEntity.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "AdverseEvent.suspectEntity.modifierExtension",
"path" : "AdverseEvent.suspectEntity.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "AdverseEvent.suspectEntity.instance",
"path" : "AdverseEvent.suspectEntity.instance",
"short" : "Refers to the specific entity that caused the adverse event",
"definition" : "Identifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device.",
"alias" : ["Substance or Medication or Device"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "AdverseEvent.suspectEntity.instance",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Immunization",
"http://hl7.org/fhir/StructureDefinition/Procedure",
"http://hl7.org/fhir/StructureDefinition/Substance",
"http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/MedicationAdministration",
"http://hl7.org/fhir/StructureDefinition/MedicationStatement",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "AdverseEvent.suspectEntity.causality",
"path" : "AdverseEvent.suspectEntity.causality",
"short" : "Information on the possible cause of the event",
"definition" : "Information on the possible cause of the event.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AdverseEvent.suspectEntity.causality",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "AdverseEvent.suspectEntity.causality.id",
"path" : "AdverseEvent.suspectEntity.causality.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "AdverseEvent.suspectEntity.causality.extension",
"path" : "AdverseEvent.suspectEntity.causality.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "AdverseEvent.suspectEntity.causality.modifierExtension",
"path" : "AdverseEvent.suspectEntity.causality.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "AdverseEvent.suspectEntity.causality.assessment",
"path" : "AdverseEvent.suspectEntity.causality.assessment",
"short" : "Assessment of if the entity caused the event",
"definition" : "Assessment of if the entity caused the event.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AdverseEvent.suspectEntity.causality.assessment",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdverseEventCausalityAssessment"
}],
"strength" : "example",
"description" : "Codes for the assessment of whether the entity caused the event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/adverse-event-causality-assess"
}
},
{
"id" : "AdverseEvent.suspectEntity.causality.productRelatedness",
"path" : "AdverseEvent.suspectEntity.causality.productRelatedness",
"short" : "AdverseEvent.suspectEntity.causalityProductRelatedness",
"definition" : "AdverseEvent.suspectEntity.causalityProductRelatedness.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AdverseEvent.suspectEntity.causality.productRelatedness",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "AdverseEvent.suspectEntity.causality.author",
"path" : "AdverseEvent.suspectEntity.causality.author",
"short" : "AdverseEvent.suspectEntity.causalityAuthor",
"definition" : "AdverseEvent.suspectEntity.causalityAuthor.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AdverseEvent.suspectEntity.causality.author",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "AdverseEvent.suspectEntity.causality.method",
"path" : "AdverseEvent.suspectEntity.causality.method",
"short" : "ProbabilityScale | Bayesian | Checklist",
"definition" : "ProbabilityScale | Bayesian | Checklist.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AdverseEvent.suspectEntity.causality.method",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdverseEventCausalityMethod"
}],
"strength" : "example",
"description" : "TODO.",
"valueSet" : "http://hl7.org/fhir/ValueSet/adverse-event-causality-method"
}
},
{
"id" : "AdverseEvent.subjectMedicalHistory",
"path" : "AdverseEvent.subjectMedicalHistory",
"short" : "AdverseEvent.subjectMedicalHistory",
"definition" : "AdverseEvent.subjectMedicalHistory.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AdverseEvent.subjectMedicalHistory",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/AllergyIntolerance",
"http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory",
"http://hl7.org/fhir/StructureDefinition/Immunization",
"http://hl7.org/fhir/StructureDefinition/Procedure",
"http://hl7.org/fhir/StructureDefinition/Media",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "AdverseEvent.referenceDocument",
"path" : "AdverseEvent.referenceDocument",
"short" : "AdverseEvent.referenceDocument",
"definition" : "AdverseEvent.referenceDocument.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AdverseEvent.referenceDocument",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "AdverseEvent.study",
"path" : "AdverseEvent.study",
"short" : "AdverseEvent.study",
"definition" : "AdverseEvent.study.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AdverseEvent.study",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ResearchStudy"]
}],
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "AdverseEvent",
"path" : "AdverseEvent",
"short" : "Medical care, research study or other healthcare event causing physical injury",
"definition" : "Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.",
"alias" : ["AE"],
"min" : 0,
"max" : "*"
},
{
"id" : "AdverseEvent.identifier",
"path" : "AdverseEvent.identifier",
"short" : "Business identifier for the event",
"definition" : "Business identifiers assigned to this adverse event by the performer or other systems which remain constant as the resource is updated and propagates from server to server.",
"comment" : "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"requirements" : "Allows identification of the adverse event as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "AdverseEvent.actuality",
"path" : "AdverseEvent.actuality",
"short" : "actual | potential",
"definition" : "Whether the event actually happened, or just had the potential to. Note that this is independent of whether anyone was affected or harmed or how severely.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it has a potential code that indicates the adverse event did not actually happen.",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdverseEventActuality"
}],
"strength" : "required",
"description" : "Overall nature of the adverse event, e.g. real or potential.",
"valueSet" : "http://hl7.org/fhir/ValueSet/adverse-event-actuality|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "AdverseEvent.category",
"path" : "AdverseEvent.category",
"short" : "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",
"definition" : "The overall type of event, intended for search and filtering purposes.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdverseEventCategory"
}],
"strength" : "extensible",
"description" : "Overall categorization of the event, e.g. product-related or situational.",
"valueSet" : "http://hl7.org/fhir/ValueSet/adverse-event-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "AdverseEvent.event",
"path" : "AdverseEvent.event",
"short" : "Type of the event itself in relation to the subject",
"definition" : "This element defines the specific type of event that occurred or that was prevented from occurring.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdverseEventType"
}],
"strength" : "example",
"description" : "Detailed type of event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/adverse-event-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
}]
},
{
"id" : "AdverseEvent.subject",
"path" : "AdverseEvent.subject",
"short" : "Subject impacted by event",
"definition" : "This subject or group impacted by the event.",
"comment" : "If AdverseEvent.resultingCondition differs among members of the group, then use Patient as the subject.",
"requirements" : "Allows for exposure of biohazard (such as legionella) to a group of individuals in a hospital.",
"alias" : ["patient"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.who"
}]
},
{
"id" : "AdverseEvent.encounter",
"path" : "AdverseEvent.encounter",
"short" : "Encounter created as part of",
"definition" : "The Encounter during which AdverseEvent was created or to which the creation of this record is tightly associated.",
"comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. For example, if a medication administration was considered an adverse event because it resulted in a rash, then the encounter when the medication administration was given is the context. If the patient reports the AdverseEvent during a second encounter, that second encounter is not the context.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
}]
},
{
"id" : "AdverseEvent.date",
"path" : "AdverseEvent.date",
"short" : "When the event occurred",
"definition" : "The date (and perhaps time) when the adverse event occurred.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.init"
}]
},
{
"id" : "AdverseEvent.detected",
"path" : "AdverseEvent.detected",
"short" : "When the event was detected",
"definition" : "Estimated or actual date the AdverseEvent began, in the opinion of the reporter.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true
},
{
"id" : "AdverseEvent.recordedDate",
"path" : "AdverseEvent.recordedDate",
"short" : "When the event was recorded",
"definition" : "The date on which the existence of the AdverseEvent was first recorded.",
"comment" : "The recordedDate represents the date when this particular AdverseEvent record was created in the system, not the date of the most recent update. The date of the last record modification can be retrieved from the resource metadata.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "AdverseEvent.resultingCondition",
"path" : "AdverseEvent.resultingCondition",
"short" : "Effect on the subject due to this event",
"definition" : "Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition"]
}],
"isSummary" : true
},
{
"id" : "AdverseEvent.location",
"path" : "AdverseEvent.location",
"short" : "Location where adverse event occurred",
"definition" : "The information about where the adverse event occurred.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"isSummary" : true
},
{
"id" : "AdverseEvent.seriousness",
"path" : "AdverseEvent.seriousness",
"short" : "Seriousness of the event",
"definition" : "Assessment whether this event was of real importance.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdverseEventSeriousness"
}],
"strength" : "example",
"description" : "Overall seriousness of this event for the patient.",
"valueSet" : "http://hl7.org/fhir/ValueSet/adverse-event-seriousness"
}
},
{
"id" : "AdverseEvent.severity",
"path" : "AdverseEvent.severity",
"short" : "mild | moderate | severe",
"definition" : "Describes the severity of the adverse event, in relation to the subject. Contrast to AdverseEvent.seriousness - a severe rash might not be serious, but a mild heart problem is.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdverseEventSeverity"
}],
"strength" : "required",
"description" : "The severity of the adverse event itself, in direct relation to the subject.",
"valueSet" : "http://hl7.org/fhir/ValueSet/adverse-event-severity|4.0.0"
}
},
{
"id" : "AdverseEvent.outcome",
"path" : "AdverseEvent.outcome",
"short" : "resolved | recovering | ongoing | resolvedWithSequelae | fatal | unknown",
"definition" : "Describes the type of outcome from the adverse event.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdverseEventOutcome"
}],
"strength" : "required",
"description" : "TODO (and should this be required?).",
"valueSet" : "http://hl7.org/fhir/ValueSet/adverse-event-outcome|4.0.0"
}
},
{
"id" : "AdverseEvent.recorder",
"path" : "AdverseEvent.recorder",
"short" : "Who recorded the adverse event",
"definition" : "Information on who recorded the adverse event. May be the patient or a practitioner.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.author"
}]
},
{
"id" : "AdverseEvent.contributor",
"path" : "AdverseEvent.contributor",
"short" : "Who was involved in the adverse event or the potential adverse event",
"definition" : "Parties that may or should contribute or have contributed information to the adverse event, which can consist of one or more activities. Such information includes information leading to the decision to perform the activity and how to perform the activity (e.g. consultant), information that the activity itself seeks to reveal (e.g. informant of clinical history), or information about what activity was performed (e.g. informant witness).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"isSummary" : true
},
{
"id" : "AdverseEvent.suspectEntity",
"path" : "AdverseEvent.suspectEntity",
"short" : "The suspected agent causing the adverse event",
"definition" : "Describes the entity that is suspected to have caused the adverse event.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "AdverseEvent.suspectEntity.instance",
"path" : "AdverseEvent.suspectEntity.instance",
"short" : "Refers to the specific entity that caused the adverse event",
"definition" : "Identifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device.",
"alias" : ["Substance or Medication or Device"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Immunization",
"http://hl7.org/fhir/StructureDefinition/Procedure",
"http://hl7.org/fhir/StructureDefinition/Substance",
"http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/MedicationAdministration",
"http://hl7.org/fhir/StructureDefinition/MedicationStatement",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"isSummary" : true
},
{
"id" : "AdverseEvent.suspectEntity.causality",
"path" : "AdverseEvent.suspectEntity.causality",
"short" : "Information on the possible cause of the event",
"definition" : "Information on the possible cause of the event.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "AdverseEvent.suspectEntity.causality.assessment",
"path" : "AdverseEvent.suspectEntity.causality.assessment",
"short" : "Assessment of if the entity caused the event",
"definition" : "Assessment of if the entity caused the event.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdverseEventCausalityAssessment"
}],
"strength" : "example",
"description" : "Codes for the assessment of whether the entity caused the event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/adverse-event-causality-assess"
}
},
{
"id" : "AdverseEvent.suspectEntity.causality.productRelatedness",
"path" : "AdverseEvent.suspectEntity.causality.productRelatedness",
"short" : "AdverseEvent.suspectEntity.causalityProductRelatedness",
"definition" : "AdverseEvent.suspectEntity.causalityProductRelatedness.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "AdverseEvent.suspectEntity.causality.author",
"path" : "AdverseEvent.suspectEntity.causality.author",
"short" : "AdverseEvent.suspectEntity.causalityAuthor",
"definition" : "AdverseEvent.suspectEntity.causalityAuthor.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"isSummary" : true
},
{
"id" : "AdverseEvent.suspectEntity.causality.method",
"path" : "AdverseEvent.suspectEntity.causality.method",
"short" : "ProbabilityScale | Bayesian | Checklist",
"definition" : "ProbabilityScale | Bayesian | Checklist.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdverseEventCausalityMethod"
}],
"strength" : "example",
"description" : "TODO.",
"valueSet" : "http://hl7.org/fhir/ValueSet/adverse-event-causality-method"
}
},
{
"id" : "AdverseEvent.subjectMedicalHistory",
"path" : "AdverseEvent.subjectMedicalHistory",
"short" : "AdverseEvent.subjectMedicalHistory",
"definition" : "AdverseEvent.subjectMedicalHistory.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/AllergyIntolerance",
"http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory",
"http://hl7.org/fhir/StructureDefinition/Immunization",
"http://hl7.org/fhir/StructureDefinition/Procedure",
"http://hl7.org/fhir/StructureDefinition/Media",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"isSummary" : true
},
{
"id" : "AdverseEvent.referenceDocument",
"path" : "AdverseEvent.referenceDocument",
"short" : "AdverseEvent.referenceDocument",
"definition" : "AdverseEvent.referenceDocument.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"isSummary" : true
},
{
"id" : "AdverseEvent.study",
"path" : "AdverseEvent.study",
"short" : "AdverseEvent.study",
"definition" : "AdverseEvent.study.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ResearchStudy"]
}],
"isSummary" : true
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "AllergyIntolerance",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints AllergyIntolerance ITU DomainResource Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
+ Rule: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.
+ Rule: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension \r\n identifier Σ 0..* Identifier External ids for this item
\r\n clinicalStatus ?!ΣI 0..1 CodeableConcept active | inactive | resolved
AllergyIntolerance Clinical Status Codes (Required) \r\n verificationStatus ?!ΣI 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
AllergyIntolerance Verification Status Codes (Required) \r\n type Σ 0..1 code allergy | intolerance - Underlying mechanism (if known)
AllergyIntoleranceType (Required) \r\n category Σ 0..* code food | medication | environment | biologic
AllergyIntoleranceCategory (Required)
\r\n criticality Σ 0..1 code low | high | unable-to-assess
AllergyIntoleranceCriticality (Required) \r\n code Σ 0..1 CodeableConcept Code that identifies the allergy or intolerance
AllergyIntolerance Substance/Product, Condition and Negation Codes (Example) \r\n patient Σ 1..1 Reference(Patient) Who the sensitivity is for \r\n encounter 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted \r\n onset[x] 0..1 When allergy or intolerance was identified \r\n onsetDateTime dateTime \r\n onsetAge Age \r\n onsetPeriod Period \r\n onsetRange Range \r\n onsetString string \r\n recordedDate 0..1 dateTime Date first version of the resource instance was recorded \r\n recorder 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who recorded the sensitivity \r\n asserter Σ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Source of the information about the allergy \r\n lastOccurrence 0..1 dateTime Date(/time) of last known occurrence of a reaction \r\n note 0..* Annotation Additional text not captured in other fields
\r\n reaction 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
\r\n substance 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Substance Code (Example) \r\n manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
SNOMED CT Clinical Findings (Example)
\r\n description 0..1 string Description of the event as a whole \r\n onset 0..1 dateTime Date(/time) when manifestations showed \r\n severity 0..1 code mild | moderate | severe (of event as a whole)
AllergyIntoleranceSeverity (Required) \r\n exposureRoute 0..1 CodeableConcept How the subject was exposed to the substance
SNOMED CT Route Codes (Example) \r\n note 0..* Annotation Text about event not captured in other fields
\r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Summary"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pc"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance",
"version" : "4.0.0",
"name" : "AllergyIntolerance",
"status" : "draft",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (Patient Care)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}]
}],
"description" : "Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.",
"purpose" : "To record a clinical assessment of a propensity, or potential risk to an individual, of an adverse reaction upon future exposure to the specified substance, or class of substance.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "AllergyIntolerance",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "AllergyIntolerance",
"path" : "AllergyIntolerance",
"short" : "Allergy or Intolerance (generally: Risk of adverse reaction to a substance)",
"definition" : "Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.",
"comment" : "Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.",
"alias" : ["Allergy",
"Intolerance",
"Adverse Reaction"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "AllergyIntolerance",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
},
{
"key" : "ait-1",
"severity" : "error",
"human" : "AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.",
"expression" : "verificationStatus='entered-in-error' or clinicalStatus.exists()",
"xpath" : "f:verificationStatus/@value='entered-in-error' or exists(f:clinicalStatus)"
},
{
"key" : "ait-2",
"severity" : "error",
"human" : "AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error",
"expression" : "verificationStatus!='entered-in-error' or clinicalStatus.empty()",
"xpath" : "f:verificationStatus/@value!='entered-in-error' or not(exists(f:clinicalStatus))"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "Observation[classCode=OBS, moodCode=EVN]"
}]
},
{
"id" : "AllergyIntolerance.id",
"path" : "AllergyIntolerance.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "AllergyIntolerance.meta",
"path" : "AllergyIntolerance.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "AllergyIntolerance.implicitRules",
"path" : "AllergyIntolerance.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "AllergyIntolerance.language",
"path" : "AllergyIntolerance.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "AllergyIntolerance.text",
"path" : "AllergyIntolerance.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "AllergyIntolerance.contained",
"path" : "AllergyIntolerance.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "AllergyIntolerance.extension",
"path" : "AllergyIntolerance.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "AllergyIntolerance.modifierExtension",
"path" : "AllergyIntolerance.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "AllergyIntolerance.identifier",
"path" : "AllergyIntolerance.identifier",
"short" : "External ids for this item",
"definition" : "Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.",
"comment" : "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"requirements" : "Allows identification of the AllergyIntolerance as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AllergyIntolerance.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "IAM-7"
},
{
"identity" : "rim",
"map" : "id"
}]
},
{
"id" : "AllergyIntolerance.clinicalStatus",
"path" : "AllergyIntolerance.clinicalStatus",
"short" : "active | inactive | resolved",
"definition" : "The clinical status of the allergy or intolerance.",
"comment" : "Refer to [discussion](extensibility.html#Special-Case) if clincalStatus is missing data.\nThe data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AllergyIntolerance.clinicalStatus",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"condition" : ["ait-1",
"ait-2"],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the status contains the codes inactive and resolved that mark the AllergyIntolerance as no longer active.",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AllergyIntoleranceClinicalStatus"
}],
"strength" : "required",
"description" : "The clinical status of the allergy or intolerance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : "Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code=\"clinicalStatus\", moodCode=EVN].value"
}]
},
{
"id" : "AllergyIntolerance.verificationStatus",
"path" : "AllergyIntolerance.verificationStatus",
"short" : "unconfirmed | confirmed | refuted | entered-in-error",
"definition" : "Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).",
"comment" : "The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AllergyIntolerance.verificationStatus",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"condition" : ["ait-1",
"ait-2"],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the status contains the codes refuted and entered-in-error that mark the AllergyIntolerance as not currently valid.",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AllergyIntoleranceVerificationStatus"
}],
"strength" : "required",
"description" : "Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : "Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code=\"verificationStatus\", moodCode=EVN].value"
}]
},
{
"id" : "AllergyIntolerance.type",
"path" : "AllergyIntolerance.type",
"short" : "allergy | intolerance - Underlying mechanism (if known)",
"definition" : "Identification of the underlying physiological mechanism for the reaction risk.",
"comment" : "Allergic (typically immune-mediated) reactions have been traditionally regarded as an indicator for potential escalation to significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune-mediated are, in fact, non-immune, but in some cases can still pose a life threatening risk. It is acknowledged that many clinicians might not be in a position to distinguish the mechanism of a particular reaction. Often the term \"allergy\" is used rather generically and may overlap with the use of \"intolerance\" - in practice the boundaries between these two concepts might not be well-defined or understood. This data element is included nevertheless, because many legacy systems have captured this attribute. Immunologic testing may provide supporting evidence for the basis of the reaction and the causative substance, but no tests are 100% sensitive or specific for sensitivity to a particular substance. If, as is commonly the case, it is unclear whether the reaction is due to an allergy or an intolerance, then the type element should be omitted from the resource.",
"alias" : ["Category",
"Class"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "AllergyIntolerance.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AllergyIntoleranceType"
}],
"strength" : "required",
"description" : "Identification of the underlying physiological mechanism for a Reaction Risk.",
"valueSet" : "http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "IAM-9"
},
{
"identity" : "rim",
"map" : "code"
}]
},
{
"id" : "AllergyIntolerance.category",
"path" : "AllergyIntolerance.category",
"short" : "food | medication | environment | biologic",
"definition" : "Category of the identified substance.",
"comment" : "This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the substance where coding systems are used, and is effectively redundant in that situation. When searching on category, consider the implications of AllergyIntolerance resources without a category. For example, when searching on category = medication, medication allergies that don't have a category valued will not be returned. Refer to [search](search.html) for more information on how to search category with a :missing modifier to get allergies that don't have a category. Additionally, category should be used with caution because category can be subjective based on the sender.",
"alias" : ["Category",
"Type",
"Reaction Type",
"Class"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "AllergyIntolerance.category",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AllergyIntoleranceCategory"
}],
"strength" : "required",
"description" : "Category of an identified substance associated with allergies or intolerances.",
"valueSet" : "http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "AL1-2"
},
{
"identity" : "rim",
"map" : "value < IntoleranceValue (Agent)"
}]
},
{
"id" : "AllergyIntolerance.criticality",
"path" : "AllergyIntolerance.criticality",
"short" : "low | high | unable-to-assess",
"definition" : "Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.",
"comment" : "The default criticality value for any propensity to an adverse reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere). Systems that capture a severity at the condition level are actually representing the concept of criticality whereas the severity documented at the reaction level is representing the true reaction severity. Existing systems that are capturing both condition criticality and reaction severity may use the term \"severity\" to represent both. Criticality is the worst it could be in the future (i.e. situation-agnostic) whereas severity is situation-dependent.",
"alias" : ["Severity",
"Seriousness",
"Contra-indication",
"Risk"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "AllergyIntolerance.criticality",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AllergyIntoleranceCriticality"
}],
"strength" : "required",
"description" : "Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.grade"
},
{
"identity" : "v2",
"map" : "AL1-4"
},
{
"identity" : "rim",
"map" : "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]"
}]
},
{
"id" : "AllergyIntolerance.code",
"path" : "AllergyIntolerance.code",
"short" : "Code that identifies the allergy or intolerance",
"definition" : "Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., \"Latex\"), an allergy or intolerance condition (e.g., \"Latex allergy\"), or a negated/excluded code for a specific substance or class (e.g., \"No latex allergy\") or a general or categorical negated statement (e.g., \"No known allergy\", \"No known drug allergies\"). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.",
"comment" : "It is strongly recommended that this element be populated using a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNII, and ATC. Plain text should only be used if there is no appropriate terminology available. Additional details can be specified in the text.\r\rWhen a substance or product code is specified for the 'code' element, the \"default\" semantic context is that this is a positive statement of an allergy or intolerance (depending on the value of the 'type' element, if present) condition to the specified substance/product. In the corresponding SNOMED CT allergy model, the specified substance/product is the target (destination) of the \"Causative agent\" relationship.\r\rThe 'substanceExposureRisk' extension is available as a structured and more flexible alternative to the 'code' element for making positive or negative allergy or intolerance statements. This extension provides the capability to make \"no known allergy\" (or \"no risk of adverse reaction\") statements regarding any coded substance/product (including cases when a pre-coordinated \"no allergy to x\" concept for that substance/product does not exist). If the 'substanceExposureRisk' extension is present, the AllergyIntolerance.code element SHALL be omitted.",
"alias" : ["Code"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "AllergyIntolerance.code",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AllergyIntoleranceCode"
}],
"strength" : "example",
"description" : "Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.",
"valueSet" : "http://hl7.org/fhir/ValueSet/allergyintolerance-code"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "AL1-3 / IAM-3"
},
{
"identity" : "rim",
"map" : "substance/product:\r\r.participation[typeCode=CAGNT].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]\r\rnegated/excluded substance/product:\r\r.participation[typeCode=CAGNT, negationInd=true].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]\r\rpositive or negated/excluded condition/situation:\r\rObservation.code=ASSERTION; Observation.value"
}]
},
{
"id" : "AllergyIntolerance.patient",
"path" : "AllergyIntolerance.patient",
"short" : "Who the sensitivity is for",
"definition" : "The patient who has the allergy or intolerance.",
"alias" : ["Patient"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "AllergyIntolerance.patient",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "(PID-3)"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role[classCode=PAT]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "AllergyIntolerance.encounter",
"path" : "AllergyIntolerance.encounter",
"short" : "Encounter when the allergy or intolerance was asserted",
"definition" : "The encounter when the allergy or intolerance was asserted.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AllergyIntolerance.encounter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}]
},
{
"id" : "AllergyIntolerance.onset[x]",
"path" : "AllergyIntolerance.onset[x]",
"short" : "When allergy or intolerance was identified",
"definition" : "Estimated or actual date, date-time, or age when allergy or intolerance was identified.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AllergyIntolerance.onset[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
},
{
"code" : "Age"
},
{
"code" : "Period"
},
{
"code" : "Range"
},
{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.init"
},
{
"identity" : "rim",
"map" : "effectiveTime.low"
}]
},
{
"id" : "AllergyIntolerance.recordedDate",
"path" : "AllergyIntolerance.recordedDate",
"short" : "Date first version of the resource instance was recorded",
"definition" : "The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AllergyIntolerance.recordedDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "v2",
"map" : "IAM-13"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].time"
}]
},
{
"id" : "AllergyIntolerance.recorder",
"path" : "AllergyIntolerance.recorder",
"short" : "Who recorded the sensitivity",
"definition" : "Individual who recorded the record and takes responsibility for its content.",
"alias" : ["Author"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "AllergyIntolerance.recorder",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
}]
},
{
"id" : "AllergyIntolerance.asserter",
"path" : "AllergyIntolerance.asserter",
"short" : "Source of the information about the allergy",
"definition" : "The source of the information about the allergy that is recorded.",
"comment" : "The recorder takes responsibility for the content, but can reference the source from where they got it.",
"alias" : ["Source",
"Informant"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "AllergyIntolerance.asserter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.source"
},
{
"identity" : "v2",
"map" : "IAM-14 (if patient) / IAM-18 (if practitioner)"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=INF].role"
}]
},
{
"id" : "AllergyIntolerance.lastOccurrence",
"path" : "AllergyIntolerance.lastOccurrence",
"short" : "Date(/time) of last known occurrence of a reaction",
"definition" : "Represents the date and/or time of the last known occurrence of a reaction event.",
"comment" : "This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the Comment element should be used.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AllergyIntolerance.lastOccurrence",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "outBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)].effectiveTime"
}]
},
{
"id" : "AllergyIntolerance.note",
"path" : "AllergyIntolerance.note",
"short" : "Additional text not captured in other fields",
"definition" : "Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.",
"comment" : "For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AllergyIntolerance.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "subjectOf.observationEvent[code=\"annotation\"].value"
}]
},
{
"id" : "AllergyIntolerance.reaction",
"path" : "AllergyIntolerance.reaction",
"short" : "Adverse Reaction Events linked to exposure to substance",
"definition" : "Details about each adverse reaction event linked to exposure to the identified substance.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AllergyIntolerance.reaction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "outBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)]"
}]
},
{
"id" : "AllergyIntolerance.reaction.id",
"path" : "AllergyIntolerance.reaction.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "AllergyIntolerance.reaction.extension",
"path" : "AllergyIntolerance.reaction.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "AllergyIntolerance.reaction.modifierExtension",
"path" : "AllergyIntolerance.reaction.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "AllergyIntolerance.reaction.substance",
"path" : "AllergyIntolerance.reaction.substance",
"short" : "Specific substance or pharmaceutical product considered to be responsible for event",
"definition" : "Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.",
"comment" : "Coding of the specific substance (or pharmaceutical product) with a terminology capable of triggering decision support should be used wherever possible. The 'code' element allows for the use of a specific substance or pharmaceutical product, or a group or class of substances. In the case of an allergy or intolerance to a class of substances, (for example, \"penicillins\"), the 'reaction.substance' element could be used to code the specific substance that was identified as having caused the reaction (for example, \"amoxycillin\"). Duplication of the value in the 'code' and 'reaction.substance' elements is acceptable when a specific substance has been recorded in 'code'.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AllergyIntolerance.reaction.substance",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubstanceCode"
}],
"strength" : "example",
"description" : "Codes defining the type of the substance (including pharmaceutical products).",
"valueSet" : "http://hl7.org/fhir/ValueSet/substance-code"
},
"mapping" : [{
"identity" : "rim",
"map" : "outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].participation[typeCode=CSM].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]"
}]
},
{
"id" : "AllergyIntolerance.reaction.manifestation",
"path" : "AllergyIntolerance.reaction.manifestation",
"short" : "Clinical symptoms/signs associated with the Event",
"definition" : "Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.",
"comment" : "Manifestation can be expressed as a single word, phrase or brief description. For example: nausea, rash or no reaction. It is preferable that manifestation should be coded with a terminology, where possible. The values entered here may be used to display on an application screen as part of a list of adverse reactions, as recommended in the UK NHS CUI guidelines. Terminologies commonly used include, but are not limited to, SNOMED CT or ICD10.",
"alias" : ["Symptoms",
"Signs"],
"min" : 1,
"max" : "*",
"base" : {
"path" : "AllergyIntolerance.reaction.manifestation",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Manifestation"
}],
"strength" : "example",
"description" : "Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/clinical-findings"
},
"mapping" : [{
"identity" : "v2",
"map" : "AL1-5"
},
{
"identity" : "rim",
"map" : "code"
}]
},
{
"id" : "AllergyIntolerance.reaction.description",
"path" : "AllergyIntolerance.reaction.description",
"short" : "Description of the event as a whole",
"definition" : "Text description about the reaction as a whole, including details of the manifestation if required.",
"comment" : "Use the description to provide any details of a particular event of the occurred reaction such as circumstances, reaction specifics, what happened before/after. Information, related to the event, but not describing a particular care should be captured in the comment field. For example: at the age of four, the patient was given penicillin for strep throat and subsequently developed severe hives.",
"alias" : ["Narrative",
"Text"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "AllergyIntolerance.reaction.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "text"
}]
},
{
"id" : "AllergyIntolerance.reaction.onset",
"path" : "AllergyIntolerance.reaction.onset",
"short" : "Date(/time) when manifestations showed",
"definition" : "Record of the date and/or time of the onset of the Reaction.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AllergyIntolerance.reaction.onset",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "AL1-6"
},
{
"identity" : "rim",
"map" : "effectiveTime.low"
}]
},
{
"id" : "AllergyIntolerance.reaction.severity",
"path" : "AllergyIntolerance.reaction.severity",
"short" : "mild | moderate | severe (of event as a whole)",
"definition" : "Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.",
"comment" : "It is acknowledged that this assessment is very subjective. There may be some specific practice domains where objective scales have been applied. Objective scales can be included in this model as extensions.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AllergyIntolerance.reaction.severity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AllergyIntoleranceSeverity"
}],
"strength" : "required",
"description" : "Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.0"
},
"mapping" : [{
"identity" : "rim",
"map" : "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]"
}]
},
{
"id" : "AllergyIntolerance.reaction.exposureRoute",
"path" : "AllergyIntolerance.reaction.exposureRoute",
"short" : "How the subject was exposed to the substance",
"definition" : "Identification of the route by which the subject was exposed to the substance.",
"comment" : "Coding of the route of exposure with a terminology should be used wherever possible.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AllergyIntolerance.reaction.exposureRoute",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RouteOfAdministration"
}],
"strength" : "example",
"description" : "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.",
"valueSet" : "http://hl7.org/fhir/ValueSet/route-codes"
},
"mapping" : [{
"identity" : "rim",
"map" : "outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].routeCode"
}]
},
{
"id" : "AllergyIntolerance.reaction.note",
"path" : "AllergyIntolerance.reaction.note",
"short" : "Text about event not captured in other fields",
"definition" : "Additional text about the adverse reaction event not captured in other fields.",
"comment" : "Use this field to record information indirectly related to a particular event and not captured in the description. For example: Clinical records are no longer available, recorded based on information provided to the patient by her mother and her mother is deceased.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AllergyIntolerance.reaction.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "subjectOf.observationEvent[code=\"annotation\"].value"
}]
}]
},
"differential" : {
"element" : [{
"id" : "AllergyIntolerance",
"path" : "AllergyIntolerance",
"short" : "Allergy or Intolerance (generally: Risk of adverse reaction to a substance)",
"definition" : "Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.",
"comment" : "Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.",
"alias" : ["Allergy",
"Intolerance",
"Adverse Reaction"],
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "ait-1",
"severity" : "error",
"human" : "AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.",
"expression" : "verificationStatus='entered-in-error' or clinicalStatus.exists()",
"xpath" : "f:verificationStatus/@value='entered-in-error' or exists(f:clinicalStatus)"
},
{
"key" : "ait-2",
"severity" : "error",
"human" : "AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error",
"expression" : "verificationStatus!='entered-in-error' or clinicalStatus.empty()",
"xpath" : "f:verificationStatus/@value!='entered-in-error' or not(exists(f:clinicalStatus))"
}],
"mapping" : [{
"identity" : "rim",
"map" : "Observation[classCode=OBS, moodCode=EVN]"
}]
},
{
"id" : "AllergyIntolerance.identifier",
"path" : "AllergyIntolerance.identifier",
"short" : "External ids for this item",
"definition" : "Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.",
"comment" : "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"requirements" : "Allows identification of the AllergyIntolerance as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "IAM-7"
},
{
"identity" : "rim",
"map" : "id"
}]
},
{
"id" : "AllergyIntolerance.clinicalStatus",
"path" : "AllergyIntolerance.clinicalStatus",
"short" : "active | inactive | resolved",
"definition" : "The clinical status of the allergy or intolerance.",
"comment" : "Refer to [discussion](extensibility.html#Special-Case) if clincalStatus is missing data.\nThe data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"condition" : ["ait-1",
"ait-2"],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the status contains the codes inactive and resolved that mark the AllergyIntolerance as no longer active.",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AllergyIntoleranceClinicalStatus"
}],
"strength" : "required",
"description" : "The clinical status of the allergy or intolerance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : "Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code=\"clinicalStatus\", moodCode=EVN].value"
}]
},
{
"id" : "AllergyIntolerance.verificationStatus",
"path" : "AllergyIntolerance.verificationStatus",
"short" : "unconfirmed | confirmed | refuted | entered-in-error",
"definition" : "Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).",
"comment" : "The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"condition" : ["ait-1",
"ait-2"],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the status contains the codes refuted and entered-in-error that mark the AllergyIntolerance as not currently valid.",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AllergyIntoleranceVerificationStatus"
}],
"strength" : "required",
"description" : "Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : "Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code=\"verificationStatus\", moodCode=EVN].value"
}]
},
{
"id" : "AllergyIntolerance.type",
"path" : "AllergyIntolerance.type",
"short" : "allergy | intolerance - Underlying mechanism (if known)",
"definition" : "Identification of the underlying physiological mechanism for the reaction risk.",
"comment" : "Allergic (typically immune-mediated) reactions have been traditionally regarded as an indicator for potential escalation to significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune-mediated are, in fact, non-immune, but in some cases can still pose a life threatening risk. It is acknowledged that many clinicians might not be in a position to distinguish the mechanism of a particular reaction. Often the term \"allergy\" is used rather generically and may overlap with the use of \"intolerance\" - in practice the boundaries between these two concepts might not be well-defined or understood. This data element is included nevertheless, because many legacy systems have captured this attribute. Immunologic testing may provide supporting evidence for the basis of the reaction and the causative substance, but no tests are 100% sensitive or specific for sensitivity to a particular substance. If, as is commonly the case, it is unclear whether the reaction is due to an allergy or an intolerance, then the type element should be omitted from the resource.",
"alias" : ["Category",
"Class"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AllergyIntoleranceType"
}],
"strength" : "required",
"description" : "Identification of the underlying physiological mechanism for a Reaction Risk.",
"valueSet" : "http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "IAM-9"
},
{
"identity" : "rim",
"map" : "code"
}]
},
{
"id" : "AllergyIntolerance.category",
"path" : "AllergyIntolerance.category",
"short" : "food | medication | environment | biologic",
"definition" : "Category of the identified substance.",
"comment" : "This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the substance where coding systems are used, and is effectively redundant in that situation. When searching on category, consider the implications of AllergyIntolerance resources without a category. For example, when searching on category = medication, medication allergies that don't have a category valued will not be returned. Refer to [search](search.html) for more information on how to search category with a :missing modifier to get allergies that don't have a category. Additionally, category should be used with caution because category can be subjective based on the sender.",
"alias" : ["Category",
"Type",
"Reaction Type",
"Class"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AllergyIntoleranceCategory"
}],
"strength" : "required",
"description" : "Category of an identified substance associated with allergies or intolerances.",
"valueSet" : "http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "AL1-2"
},
{
"identity" : "rim",
"map" : "value < IntoleranceValue (Agent)"
}]
},
{
"id" : "AllergyIntolerance.criticality",
"path" : "AllergyIntolerance.criticality",
"short" : "low | high | unable-to-assess",
"definition" : "Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.",
"comment" : "The default criticality value for any propensity to an adverse reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere). Systems that capture a severity at the condition level are actually representing the concept of criticality whereas the severity documented at the reaction level is representing the true reaction severity. Existing systems that are capturing both condition criticality and reaction severity may use the term \"severity\" to represent both. Criticality is the worst it could be in the future (i.e. situation-agnostic) whereas severity is situation-dependent.",
"alias" : ["Severity",
"Seriousness",
"Contra-indication",
"Risk"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AllergyIntoleranceCriticality"
}],
"strength" : "required",
"description" : "Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.grade"
},
{
"identity" : "v2",
"map" : "AL1-4"
},
{
"identity" : "rim",
"map" : "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]"
}]
},
{
"id" : "AllergyIntolerance.code",
"path" : "AllergyIntolerance.code",
"short" : "Code that identifies the allergy or intolerance",
"definition" : "Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., \"Latex\"), an allergy or intolerance condition (e.g., \"Latex allergy\"), or a negated/excluded code for a specific substance or class (e.g., \"No latex allergy\") or a general or categorical negated statement (e.g., \"No known allergy\", \"No known drug allergies\"). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.",
"comment" : "It is strongly recommended that this element be populated using a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNII, and ATC. Plain text should only be used if there is no appropriate terminology available. Additional details can be specified in the text.\r\rWhen a substance or product code is specified for the 'code' element, the \"default\" semantic context is that this is a positive statement of an allergy or intolerance (depending on the value of the 'type' element, if present) condition to the specified substance/product. In the corresponding SNOMED CT allergy model, the specified substance/product is the target (destination) of the \"Causative agent\" relationship.\r\rThe 'substanceExposureRisk' extension is available as a structured and more flexible alternative to the 'code' element for making positive or negative allergy or intolerance statements. This extension provides the capability to make \"no known allergy\" (or \"no risk of adverse reaction\") statements regarding any coded substance/product (including cases when a pre-coordinated \"no allergy to x\" concept for that substance/product does not exist). If the 'substanceExposureRisk' extension is present, the AllergyIntolerance.code element SHALL be omitted.",
"alias" : ["Code"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AllergyIntoleranceCode"
}],
"strength" : "example",
"description" : "Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.",
"valueSet" : "http://hl7.org/fhir/ValueSet/allergyintolerance-code"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "AL1-3 / IAM-3"
},
{
"identity" : "rim",
"map" : "substance/product:\r\r.participation[typeCode=CAGNT].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]\r\rnegated/excluded substance/product:\r\r.participation[typeCode=CAGNT, negationInd=true].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]\r\rpositive or negated/excluded condition/situation:\r\rObservation.code=ASSERTION; Observation.value"
}]
},
{
"id" : "AllergyIntolerance.patient",
"path" : "AllergyIntolerance.patient",
"short" : "Who the sensitivity is for",
"definition" : "The patient who has the allergy or intolerance.",
"alias" : ["Patient"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "(PID-3)"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role[classCode=PAT]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "AllergyIntolerance.encounter",
"path" : "AllergyIntolerance.encounter",
"short" : "Encounter when the allergy or intolerance was asserted",
"definition" : "The encounter when the allergy or intolerance was asserted.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}]
},
{
"id" : "AllergyIntolerance.onset[x]",
"path" : "AllergyIntolerance.onset[x]",
"short" : "When allergy or intolerance was identified",
"definition" : "Estimated or actual date, date-time, or age when allergy or intolerance was identified.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
},
{
"code" : "Age"
},
{
"code" : "Period"
},
{
"code" : "Range"
},
{
"code" : "string"
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.init"
},
{
"identity" : "rim",
"map" : "effectiveTime.low"
}]
},
{
"id" : "AllergyIntolerance.recordedDate",
"path" : "AllergyIntolerance.recordedDate",
"short" : "Date first version of the resource instance was recorded",
"definition" : "The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "v2",
"map" : "IAM-13"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].time"
}]
},
{
"id" : "AllergyIntolerance.recorder",
"path" : "AllergyIntolerance.recorder",
"short" : "Who recorded the sensitivity",
"definition" : "Individual who recorded the record and takes responsibility for its content.",
"alias" : ["Author"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
}]
},
{
"id" : "AllergyIntolerance.asserter",
"path" : "AllergyIntolerance.asserter",
"short" : "Source of the information about the allergy",
"definition" : "The source of the information about the allergy that is recorded.",
"comment" : "The recorder takes responsibility for the content, but can reference the source from where they got it.",
"alias" : ["Source",
"Informant"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.source"
},
{
"identity" : "v2",
"map" : "IAM-14 (if patient) / IAM-18 (if practitioner)"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=INF].role"
}]
},
{
"id" : "AllergyIntolerance.lastOccurrence",
"path" : "AllergyIntolerance.lastOccurrence",
"short" : "Date(/time) of last known occurrence of a reaction",
"definition" : "Represents the date and/or time of the last known occurrence of a reaction event.",
"comment" : "This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the Comment element should be used.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"mapping" : [{
"identity" : "rim",
"map" : "outBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)].effectiveTime"
}]
},
{
"id" : "AllergyIntolerance.note",
"path" : "AllergyIntolerance.note",
"short" : "Additional text not captured in other fields",
"definition" : "Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.",
"comment" : "For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}],
"mapping" : [{
"identity" : "rim",
"map" : "subjectOf.observationEvent[code=\"annotation\"].value"
}]
},
{
"id" : "AllergyIntolerance.reaction",
"path" : "AllergyIntolerance.reaction",
"short" : "Adverse Reaction Events linked to exposure to substance",
"definition" : "Details about each adverse reaction event linked to exposure to the identified substance.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : "outBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)]"
}]
},
{
"id" : "AllergyIntolerance.reaction.substance",
"path" : "AllergyIntolerance.reaction.substance",
"short" : "Specific substance or pharmaceutical product considered to be responsible for event",
"definition" : "Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.",
"comment" : "Coding of the specific substance (or pharmaceutical product) with a terminology capable of triggering decision support should be used wherever possible. The 'code' element allows for the use of a specific substance or pharmaceutical product, or a group or class of substances. In the case of an allergy or intolerance to a class of substances, (for example, \"penicillins\"), the 'reaction.substance' element could be used to code the specific substance that was identified as having caused the reaction (for example, \"amoxycillin\"). Duplication of the value in the 'code' and 'reaction.substance' elements is acceptable when a specific substance has been recorded in 'code'.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubstanceCode"
}],
"strength" : "example",
"description" : "Codes defining the type of the substance (including pharmaceutical products).",
"valueSet" : "http://hl7.org/fhir/ValueSet/substance-code"
},
"mapping" : [{
"identity" : "rim",
"map" : "outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].participation[typeCode=CSM].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]"
}]
},
{
"id" : "AllergyIntolerance.reaction.manifestation",
"path" : "AllergyIntolerance.reaction.manifestation",
"short" : "Clinical symptoms/signs associated with the Event",
"definition" : "Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.",
"comment" : "Manifestation can be expressed as a single word, phrase or brief description. For example: nausea, rash or no reaction. It is preferable that manifestation should be coded with a terminology, where possible. The values entered here may be used to display on an application screen as part of a list of adverse reactions, as recommended in the UK NHS CUI guidelines. Terminologies commonly used include, but are not limited to, SNOMED CT or ICD10.",
"alias" : ["Symptoms",
"Signs"],
"min" : 1,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Manifestation"
}],
"strength" : "example",
"description" : "Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/clinical-findings"
},
"mapping" : [{
"identity" : "v2",
"map" : "AL1-5"
},
{
"identity" : "rim",
"map" : "code"
}]
},
{
"id" : "AllergyIntolerance.reaction.description",
"path" : "AllergyIntolerance.reaction.description",
"short" : "Description of the event as a whole",
"definition" : "Text description about the reaction as a whole, including details of the manifestation if required.",
"comment" : "Use the description to provide any details of a particular event of the occurred reaction such as circumstances, reaction specifics, what happened before/after. Information, related to the event, but not describing a particular care should be captured in the comment field. For example: at the age of four, the patient was given penicillin for strep throat and subsequently developed severe hives.",
"alias" : ["Narrative",
"Text"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "rim",
"map" : "text"
}]
},
{
"id" : "AllergyIntolerance.reaction.onset",
"path" : "AllergyIntolerance.reaction.onset",
"short" : "Date(/time) when manifestations showed",
"definition" : "Record of the date and/or time of the onset of the Reaction.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"mapping" : [{
"identity" : "v2",
"map" : "AL1-6"
},
{
"identity" : "rim",
"map" : "effectiveTime.low"
}]
},
{
"id" : "AllergyIntolerance.reaction.severity",
"path" : "AllergyIntolerance.reaction.severity",
"short" : "mild | moderate | severe (of event as a whole)",
"definition" : "Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.",
"comment" : "It is acknowledged that this assessment is very subjective. There may be some specific practice domains where objective scales have been applied. Objective scales can be included in this model as extensions.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AllergyIntoleranceSeverity"
}],
"strength" : "required",
"description" : "Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.0"
},
"mapping" : [{
"identity" : "rim",
"map" : "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]"
}]
},
{
"id" : "AllergyIntolerance.reaction.exposureRoute",
"path" : "AllergyIntolerance.reaction.exposureRoute",
"short" : "How the subject was exposed to the substance",
"definition" : "Identification of the route by which the subject was exposed to the substance.",
"comment" : "Coding of the route of exposure with a terminology should be used wherever possible.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RouteOfAdministration"
}],
"strength" : "example",
"description" : "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.",
"valueSet" : "http://hl7.org/fhir/ValueSet/route-codes"
},
"mapping" : [{
"identity" : "rim",
"map" : "outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].routeCode"
}]
},
{
"id" : "AllergyIntolerance.reaction.note",
"path" : "AllergyIntolerance.reaction.note",
"short" : "Text about event not captured in other fields",
"definition" : "Additional text about the adverse reaction event not captured in other fields.",
"comment" : "Use this field to record information indirectly related to a particular event and not captured in the description. For example: Clinical records are no longer available, recorded based on information provided to the patient by her mother and her mother is deceased.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}],
"mapping" : [{
"identity" : "rim",
"map" : "subjectOf.observationEvent[code=\"annotation\"].value"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/Appointment",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "Appointment",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints Appointment ITU DomainResource A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
+ Rule: Either start and end are specified, or neither
+ Rule: Only proposed or cancelled appointments can be missing start/end dates
+ Rule: Cancelation reason is only used for appointments that have been cancelled, or no-show
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension \r\n identifier Σ 0..* Identifier External Ids for this item
\r\n status ?!Σ 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
AppointmentStatus (Required) \r\n cancelationReason Σ 0..1 CodeableConcept The coded reason for the appointment being cancelled
Appointment cancellation reason (Example) \r\n serviceCategory Σ 0..* CodeableConcept A broad categorization of the service that is to be performed during this appointment
Service category (Example)
\r\n serviceType Σ 0..* CodeableConcept The specific service that is to be performed during this appointment
Service type (Example)
\r\n specialty Σ 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
Practice Setting Code Value Set (Preferred)
\r\n appointmentType Σ 0..1 CodeableConcept The style of appointment or patient that has been booked in the slot (not service type)
v2 Appointment Reason Codes (Preferred) \r\n reasonCode Σ 0..* CodeableConcept Coded reason this appointment is scheduled
Encounter Reason Codes (Preferred)
\r\n reasonReference 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the appointment is to take place (resource)
\r\n priority 0..1 unsignedInt Used to make informed decisions if needing to re-prioritize \r\n description 0..1 string Shown on a subject line in a meeting request, or appointment list \r\n supportingInformation 0..* Reference(Any) Additional information to support the appointment
\r\n start Σ 0..1 instant When appointment is to take place \r\n end Σ 0..1 instant When appointment is to conclude \r\n minutesDuration 0..1 positiveInt Can be less than start/end (e.g. estimate) \r\n slot 0..* Reference(Slot) The slots that this appointment is filling
\r\n created 0..1 dateTime The date that this appointment was initially created \r\n comment 0..1 string Additional comments \r\n patientInstruction 0..1 string Detailed information and instructions for the patient \r\n basedOn 0..* Reference(ServiceRequest) The service request this appointment is allocated to assess
\r\n participant I 1..* BackboneElement Participants involved in appointment
+ Rule: Either the type or actor on the participant SHALL be specified
\r\n type Σ 0..* CodeableConcept Role of participant in the appointment
Participant type (Extensible)
\r\n actor Σ 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) Person, Location/HealthcareService or Device \r\n required Σ 0..1 code required | optional | information-only
ParticipantRequired (Required) \r\n status Σ 1..1 code accepted | declined | tentative | needs-action
ParticipationStatus (Required) \r\n period 0..1 Period Participation period of the actor \r\n requestedPeriod 0..* Period Potential date/time interval(s) requested to allocate the appointment within
\r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Base.Workflow"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pa"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Appointment",
"version" : "4.0.0",
"name" : "Appointment",
"status" : "draft",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (Patient Administration)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/pafm/index.cfm"
}]
}],
"description" : "A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "ical",
"uri" : "http://ietf.org/rfc/2445",
"name" : "iCalendar"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Appointment",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Appointment",
"path" : "Appointment",
"short" : "A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)",
"definition" : "A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Appointment",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
},
{
"key" : "app-4",
"severity" : "error",
"human" : "Cancelation reason is only used for appointments that have been cancelled, or no-show",
"expression" : "Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')",
"xpath" : "not(exists(f:cancellationReason)) or f:status/@value=('no-show', 'cancelled')"
},
{
"key" : "app-3",
"severity" : "error",
"human" : "Only proposed or cancelled appointments can be missing start/end dates",
"expression" : "(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))",
"xpath" : "((exists(f:start) and exists(f:end)) or (f:status/@value='proposed') or (f:status/@value='cancelled') or (f:status/@value='waitlist'))"
},
{
"key" : "app-2",
"severity" : "error",
"human" : "Either start and end are specified, or neither",
"expression" : "start.exists() = end.exists()",
"xpath" : "((exists(f:start) and exists(f:end)) or (not(exists(f:start)) and not(exists(f:end))))"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Request"
},
{
"identity" : "rim",
"map" : "Act[@moodCode <= 'INT']"
},
{
"identity" : "ical",
"map" : "VEVENT"
}]
},
{
"id" : "Appointment.id",
"path" : "Appointment.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Appointment.meta",
"path" : "Appointment.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Appointment.implicitRules",
"path" : "Appointment.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Appointment.language",
"path" : "Appointment.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Appointment.text",
"path" : "Appointment.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Appointment.contained",
"path" : "Appointment.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Appointment.extension",
"path" : "Appointment.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Appointment.modifierExtension",
"path" : "Appointment.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Appointment.identifier",
"path" : "Appointment.identifier",
"short" : "External Ids for this item",
"definition" : "This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Appointment.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "SCH-1, SCH-2, ARQ-1, ARQ-2"
},
{
"identity" : "rim",
"map" : ".id"
},
{
"identity" : "ical",
"map" : "UID"
}]
},
{
"id" : "Appointment.status",
"path" : "Appointment.status",
"short" : "proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist",
"definition" : "The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.",
"comment" : "If the Appointment's status is \"cancelled\" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE.\n\nThis element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Appointment.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AppointmentStatus"
}],
"strength" : "required",
"description" : "The free/busy status of an appointment.",
"valueSet" : "http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "SCH-25"
},
{
"identity" : "rim",
"map" : ".statusCode"
},
{
"identity" : "ical",
"map" : "STATUS"
}]
},
{
"id" : "Appointment.cancelationReason",
"path" : "Appointment.cancelationReason",
"short" : "The coded reason for the appointment being cancelled",
"definition" : "The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Appointment.cancelationReason",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "cancelation-reason"
}],
"strength" : "example",
"valueSet" : "http://hl7.org/fhir/ValueSet/appointment-cancellation-reason"
},
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Appointment.serviceCategory",
"path" : "Appointment.serviceCategory",
"short" : "A broad categorization of the service that is to be performed during this appointment",
"definition" : "A broad categorization of the service that is to be performed during this appointment.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Appointment.serviceCategory",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "service-category"
}],
"strength" : "example",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-category"
},
"mapping" : [{
"identity" : "rim",
"map" : "n/a, might be inferred from the ServiceDeliveryLocation"
},
{
"identity" : "ical",
"map" : "CATEGORIES"
}]
},
{
"id" : "Appointment.serviceType",
"path" : "Appointment.serviceType",
"short" : "The specific service that is to be performed during this appointment",
"definition" : "The specific service that is to be performed during this appointment.",
"comment" : "For a provider to provider appointment the code \"FOLLOWUP\" may be appropriate, as this is expected to be discussing some patient that was seen in the past.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Appointment.serviceType",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "service-type"
}],
"strength" : "example",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "rim",
"map" : "n/a, might be inferred from the ServiceDeliveryLocation"
}]
},
{
"id" : "Appointment.specialty",
"path" : "Appointment.specialty",
"short" : "The specialty of a practitioner that would be required to perform the service requested in this appointment",
"definition" : "The specialty of a practitioner that would be required to perform the service requested in this appointment.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Appointment.specialty",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "specialty"
}],
"strength" : "preferred",
"valueSet" : "http://hl7.org/fhir/ValueSet/c80-practice-codes"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".performer.AssignedPerson.code"
}]
},
{
"id" : "Appointment.appointmentType",
"path" : "Appointment.appointmentType",
"short" : "The style of appointment or patient that has been booked in the slot (not service type)",
"definition" : "The style of appointment or patient that has been booked in the slot (not service type).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Appointment.appointmentType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "appointment-type"
}],
"strength" : "preferred",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0276"
},
"mapping" : [{
"identity" : "v2",
"map" : "ARQ-7"
},
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "ical",
"map" : "CLASSIFICATION"
}]
},
{
"id" : "Appointment.reasonCode",
"path" : "Appointment.reasonCode",
"short" : "Coded reason this appointment is scheduled",
"definition" : "The coded reason that this appointment is being scheduled. This is more clinical than administrative.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Appointment.reasonCode",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ApptReason"
}],
"strength" : "preferred",
"description" : "The Reason for the appointment to take place.",
"valueSet" : "http://hl7.org/fhir/ValueSet/encounter-reason"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonCode"
},
{
"identity" : "v2",
"map" : "AIS-3, SCH-7"
},
{
"identity" : "rim",
"map" : ".reasonCode"
}]
},
{
"id" : "Appointment.reasonReference",
"path" : "Appointment.reasonReference",
"short" : "Reason the appointment is to take place (resource)",
"definition" : "Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Appointment.reasonReference",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Procedure",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonReference"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[@typeCode = 'RSON'].observation"
}]
},
{
"id" : "Appointment.priority",
"path" : "Appointment.priority",
"short" : "Used to make informed decisions if needing to re-prioritize",
"definition" : "The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).",
"comment" : "Seeking implementer feedback on this property and how interoperable it is.\r\rUsing an extension to record a CodeableConcept for named values may be tested at a future connectathon.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Appointment.priority",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "unsignedInt"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.priority"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "ARQ-12, SCH-11.6 / TQ1-9"
},
{
"identity" : "rim",
"map" : ".priorityCode"
},
{
"identity" : "ical",
"map" : "PRIORITY"
}]
},
{
"id" : "Appointment.description",
"path" : "Appointment.description",
"short" : "Shown on a subject line in a meeting request, or appointment list",
"definition" : "The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Appointment.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "NTE-3"
},
{
"identity" : "rim",
"map" : ".text"
},
{
"identity" : "ical",
"map" : "SUMMARY"
}]
},
{
"id" : "Appointment.supportingInformation",
"path" : "Appointment.supportingInformation",
"short" : "Additional information to support the appointment",
"definition" : "Additional information to support the appointment provided when making the appointment.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Appointment.supportingInformation",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.supportingInfo"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[@typeCode = 'SPRT'].observation"
},
{
"identity" : "ical",
"map" : "ATTACH"
}]
},
{
"id" : "Appointment.start",
"path" : "Appointment.start",
"short" : "When appointment is to take place",
"definition" : "Date/Time that the appointment is to take place.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Appointment.start",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "instant"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.init"
},
{
"identity" : "v2",
"map" : "ARQ-11.1, SCH-11.4 / TQ1-7"
},
{
"identity" : "rim",
"map" : ".effectiveTime.low"
},
{
"identity" : "ical",
"map" : "DTSTART"
}]
},
{
"id" : "Appointment.end",
"path" : "Appointment.end",
"short" : "When appointment is to conclude",
"definition" : "Date/Time that the appointment is to conclude.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Appointment.end",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "instant"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "v2",
"map" : "SCH-11.5 / TQ1-8/ calculated based on the start and the duration which is in ARQ-9"
},
{
"identity" : "rim",
"map" : ".effectiveTime.high"
},
{
"identity" : "ical",
"map" : "DTEND"
}]
},
{
"id" : "Appointment.minutesDuration",
"path" : "Appointment.minutesDuration",
"short" : "Can be less than start/end (e.g. estimate)",
"definition" : "Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Appointment.minutesDuration",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "rim",
"map" : ".activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')].width"
},
{
"identity" : "ical",
"map" : "DURATION (e.g. PT15M)"
}]
},
{
"id" : "Appointment.slot",
"path" : "Appointment.slot",
"short" : "The slots that this appointment is filling",
"definition" : "The slots from the participants' schedules that will be filled by the appointment.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Appointment.slot",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Slot"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[@typeCode = 'REFR'].act[@classCode = 'ACT'][@moodCode = 'SLOT']"
}]
},
{
"id" : "Appointment.created",
"path" : "Appointment.created",
"short" : "The date that this appointment was initially created",
"definition" : "The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.",
"comment" : "This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Appointment.created",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.authoredOn"
},
{
"identity" : "rim",
"map" : ".author.time"
},
{
"identity" : "ical",
"map" : "CREATED"
}]
},
{
"id" : "Appointment.comment",
"path" : "Appointment.comment",
"short" : "Additional comments",
"definition" : "Additional comments about the appointment.",
"comment" : "Additional text to aid in facilitating the appointment. For instance, a comment might be, \"patient should proceed immediately to infusion room upon arrival\"\r\rWhere this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Appointment.comment",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.note"
},
{
"identity" : "v2",
"map" : "NTE-3"
},
{
"identity" : "rim",
"map" : ".subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value"
},
{
"identity" : "ical",
"map" : "DESCRIPTION (for internal use)"
}]
},
{
"id" : "Appointment.patientInstruction",
"path" : "Appointment.patientInstruction",
"short" : "Detailed information and instructions for the patient",
"definition" : "While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Appointment.patientInstruction",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "NTE-3"
},
{
"identity" : "rim",
"map" : ".subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value"
},
{
"identity" : "ical",
"map" : "DESCRIPTION (for patient use)"
}]
},
{
"id" : "Appointment.basedOn",
"path" : "Appointment.basedOn",
"short" : "The service request this appointment is allocated to assess",
"definition" : "The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).",
"alias" : ["incomingReferral"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Appointment.basedOn",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ServiceRequest"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.basedOn"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[@typeCode = 'FLFS'].act[@classCode < 'ActCareProvisionRequestType'][@moodCode = 'RQO']"
}]
},
{
"id" : "Appointment.participant",
"path" : "Appointment.participant",
"short" : "Participants involved in appointment",
"definition" : "List of participants involved in the appointment.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Appointment.participant",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "app-1",
"severity" : "error",
"human" : "Either the type or actor on the participant SHALL be specified",
"expression" : "type.exists() or actor.exists()",
"xpath" : "(exists(f:type) or exists(f:actor))"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performer, Request.subject"
},
{
"identity" : "v2",
"map" : "PID, AIP, AIG, AIL"
},
{
"identity" : "rim",
"map" : "performer | reusableDevice | subject | location"
},
{
"identity" : "ical",
"map" : "ATTENDEE component to be created"
}]
},
{
"id" : "Appointment.participant.id",
"path" : "Appointment.participant.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Appointment.participant.extension",
"path" : "Appointment.participant.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Appointment.participant.modifierExtension",
"path" : "Appointment.participant.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Appointment.participant.type",
"path" : "Appointment.participant.type",
"short" : "Role of participant in the appointment",
"definition" : "Role of participant in the appointment.",
"comment" : "The role of the participant can be used to declare what the actor will be doing in the scope of this appointment.\r\rIf the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning.\r\rThis value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Appointment.participant.type",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ParticipantType"
}],
"strength" : "extensible",
"description" : "Role of participant in encounter.",
"valueSet" : "http://hl7.org/fhir/ValueSet/encounter-participant-type"
},
"mapping" : [{
"identity" : "v2",
"map" : "AIP-4, AIG-4"
},
{
"identity" : "rim",
"map" : "(performer | reusableDevice | subject | location).@typeCode"
},
{
"identity" : "ical",
"map" : "n/a"
}]
},
{
"id" : "Appointment.participant.actor",
"path" : "Appointment.participant.actor",
"short" : "Person, Location/HealthcareService or Device",
"definition" : "A Person, Location/HealthcareService or Device that is participating in the appointment.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Appointment.participant.actor",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Location"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.who"
},
{
"identity" : "v2",
"map" : "PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3"
},
{
"identity" : "rim",
"map" : "performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation"
},
{
"identity" : "ical",
"map" : "ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not \"information-only\""
}]
},
{
"id" : "Appointment.participant.required",
"path" : "Appointment.participant.required",
"short" : "required | optional | information-only",
"definition" : "Whether this participant is required to be present at the meeting. This covers a use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Appointment.participant.required",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ParticipantRequired"
}],
"strength" : "required",
"description" : "Is the Participant required to attend the appointment.",
"valueSet" : "http://hl7.org/fhir/ValueSet/participantrequired|4.0.0"
},
"mapping" : [{
"identity" : "rim",
"map" : "(performer | reusableDevice | subject | location).@performInd"
},
{
"identity" : "ical",
"map" : "ROLE=REQ-PARTICIPANT (roleparam)"
}]
},
{
"id" : "Appointment.participant.status",
"path" : "Appointment.participant.status",
"short" : "accepted | declined | tentative | needs-action",
"definition" : "Participation status of the actor.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Appointment.participant.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ParticipationStatus"
}],
"strength" : "required",
"description" : "The Participation status of an appointment.",
"valueSet" : "http://hl7.org/fhir/ValueSet/participationstatus|4.0.0"
},
"mapping" : [{
"identity" : "v2",
"map" : "AIP-12, AIG-14"
},
{
"identity" : "rim",
"map" : "(performer | reusableDevice | subject | location).statusCode"
},
{
"identity" : "ical",
"map" : "ATTENDEE;CN=\"John Doe\";RSVP=TRUE:mailto:[email protected] (rsvpparam | partstatparam)"
}]
},
{
"id" : "Appointment.participant.period",
"path" : "Appointment.participant.period",
"short" : "Participation period of the actor",
"definition" : "Participation period of the actor.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Appointment.participant.period",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Appointment.requestedPeriod",
"path" : "Appointment.requestedPeriod",
"short" : "Potential date/time interval(s) requested to allocate the appointment within",
"definition" : "A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.\n\nThe duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.",
"comment" : "This does not introduce a capacity for recurring appointments.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Appointment.requestedPeriod",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Period"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "v2",
"map" : "ARQ-11"
},
{
"identity" : "rim",
"map" : ".activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')]"
}]
}]
},
"differential" : {
"element" : [{
"id" : "Appointment",
"path" : "Appointment",
"short" : "A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)",
"definition" : "A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "app-4",
"severity" : "error",
"human" : "Cancelation reason is only used for appointments that have been cancelled, or no-show",
"expression" : "Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')",
"xpath" : "not(exists(f:cancellationReason)) or f:status/@value=('no-show', 'cancelled')"
},
{
"key" : "app-3",
"severity" : "error",
"human" : "Only proposed or cancelled appointments can be missing start/end dates",
"expression" : "(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))",
"xpath" : "((exists(f:start) and exists(f:end)) or (f:status/@value='proposed') or (f:status/@value='cancelled') or (f:status/@value='waitlist'))"
},
{
"key" : "app-2",
"severity" : "error",
"human" : "Either start and end are specified, or neither",
"expression" : "start.exists() = end.exists()",
"xpath" : "((exists(f:start) and exists(f:end)) or (not(exists(f:start)) and not(exists(f:end))))"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request"
},
{
"identity" : "rim",
"map" : "Act[@moodCode <= 'INT']"
},
{
"identity" : "ical",
"map" : "VEVENT"
}]
},
{
"id" : "Appointment.identifier",
"path" : "Appointment.identifier",
"short" : "External Ids for this item",
"definition" : "This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "SCH-1, SCH-2, ARQ-1, ARQ-2"
},
{
"identity" : "rim",
"map" : ".id"
},
{
"identity" : "ical",
"map" : "UID"
}]
},
{
"id" : "Appointment.status",
"path" : "Appointment.status",
"short" : "proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist",
"definition" : "The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.",
"comment" : "If the Appointment's status is \"cancelled\" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE.\n\nThis element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AppointmentStatus"
}],
"strength" : "required",
"description" : "The free/busy status of an appointment.",
"valueSet" : "http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "SCH-25"
},
{
"identity" : "rim",
"map" : ".statusCode"
},
{
"identity" : "ical",
"map" : "STATUS"
}]
},
{
"id" : "Appointment.cancelationReason",
"path" : "Appointment.cancelationReason",
"short" : "The coded reason for the appointment being cancelled",
"definition" : "The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "cancelation-reason"
}],
"strength" : "example",
"valueSet" : "http://hl7.org/fhir/ValueSet/appointment-cancellation-reason"
},
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Appointment.serviceCategory",
"path" : "Appointment.serviceCategory",
"short" : "A broad categorization of the service that is to be performed during this appointment",
"definition" : "A broad categorization of the service that is to be performed during this appointment.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "service-category"
}],
"strength" : "example",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-category"
},
"mapping" : [{
"identity" : "rim",
"map" : "n/a, might be inferred from the ServiceDeliveryLocation"
},
{
"identity" : "ical",
"map" : "CATEGORIES"
}]
},
{
"id" : "Appointment.serviceType",
"path" : "Appointment.serviceType",
"short" : "The specific service that is to be performed during this appointment",
"definition" : "The specific service that is to be performed during this appointment.",
"comment" : "For a provider to provider appointment the code \"FOLLOWUP\" may be appropriate, as this is expected to be discussing some patient that was seen in the past.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "service-type"
}],
"strength" : "example",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "rim",
"map" : "n/a, might be inferred from the ServiceDeliveryLocation"
}]
},
{
"id" : "Appointment.specialty",
"path" : "Appointment.specialty",
"short" : "The specialty of a practitioner that would be required to perform the service requested in this appointment",
"definition" : "The specialty of a practitioner that would be required to perform the service requested in this appointment.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "specialty"
}],
"strength" : "preferred",
"valueSet" : "http://hl7.org/fhir/ValueSet/c80-practice-codes"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".performer.AssignedPerson.code"
}]
},
{
"id" : "Appointment.appointmentType",
"path" : "Appointment.appointmentType",
"short" : "The style of appointment or patient that has been booked in the slot (not service type)",
"definition" : "The style of appointment or patient that has been booked in the slot (not service type).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "appointment-type"
}],
"strength" : "preferred",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0276"
},
"mapping" : [{
"identity" : "v2",
"map" : "ARQ-7"
},
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "ical",
"map" : "CLASSIFICATION"
}]
},
{
"id" : "Appointment.reasonCode",
"path" : "Appointment.reasonCode",
"short" : "Coded reason this appointment is scheduled",
"definition" : "The coded reason that this appointment is being scheduled. This is more clinical than administrative.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ApptReason"
}],
"strength" : "preferred",
"description" : "The Reason for the appointment to take place.",
"valueSet" : "http://hl7.org/fhir/ValueSet/encounter-reason"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonCode"
},
{
"identity" : "v2",
"map" : "AIS-3, SCH-7"
},
{
"identity" : "rim",
"map" : ".reasonCode"
}]
},
{
"id" : "Appointment.reasonReference",
"path" : "Appointment.reasonReference",
"short" : "Reason the appointment is to take place (resource)",
"definition" : "Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Procedure",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonReference"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[@typeCode = 'RSON'].observation"
}]
},
{
"id" : "Appointment.priority",
"path" : "Appointment.priority",
"short" : "Used to make informed decisions if needing to re-prioritize",
"definition" : "The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).",
"comment" : "Seeking implementer feedback on this property and how interoperable it is.\r\rUsing an extension to record a CodeableConcept for named values may be tested at a future connectathon.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "unsignedInt"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.priority"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "ARQ-12, SCH-11.6 / TQ1-9"
},
{
"identity" : "rim",
"map" : ".priorityCode"
},
{
"identity" : "ical",
"map" : "PRIORITY"
}]
},
{
"id" : "Appointment.description",
"path" : "Appointment.description",
"short" : "Shown on a subject line in a meeting request, or appointment list",
"definition" : "The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "v2",
"map" : "NTE-3"
},
{
"identity" : "rim",
"map" : ".text"
},
{
"identity" : "ical",
"map" : "SUMMARY"
}]
},
{
"id" : "Appointment.supportingInformation",
"path" : "Appointment.supportingInformation",
"short" : "Additional information to support the appointment",
"definition" : "Additional information to support the appointment provided when making the appointment.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.supportingInfo"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[@typeCode = 'SPRT'].observation"
},
{
"identity" : "ical",
"map" : "ATTACH"
}]
},
{
"id" : "Appointment.start",
"path" : "Appointment.start",
"short" : "When appointment is to take place",
"definition" : "Date/Time that the appointment is to take place.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "instant"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.init"
},
{
"identity" : "v2",
"map" : "ARQ-11.1, SCH-11.4 / TQ1-7"
},
{
"identity" : "rim",
"map" : ".effectiveTime.low"
},
{
"identity" : "ical",
"map" : "DTSTART"
}]
},
{
"id" : "Appointment.end",
"path" : "Appointment.end",
"short" : "When appointment is to conclude",
"definition" : "Date/Time that the appointment is to conclude.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "instant"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "v2",
"map" : "SCH-11.5 / TQ1-8/ calculated based on the start and the duration which is in ARQ-9"
},
{
"identity" : "rim",
"map" : ".effectiveTime.high"
},
{
"identity" : "ical",
"map" : "DTEND"
}]
},
{
"id" : "Appointment.minutesDuration",
"path" : "Appointment.minutesDuration",
"short" : "Can be less than start/end (e.g. estimate)",
"definition" : "Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "rim",
"map" : ".activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')].width"
},
{
"identity" : "ical",
"map" : "DURATION (e.g. PT15M)"
}]
},
{
"id" : "Appointment.slot",
"path" : "Appointment.slot",
"short" : "The slots that this appointment is filling",
"definition" : "The slots from the participants' schedules that will be filled by the appointment.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Slot"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[@typeCode = 'REFR'].act[@classCode = 'ACT'][@moodCode = 'SLOT']"
}]
},
{
"id" : "Appointment.created",
"path" : "Appointment.created",
"short" : "The date that this appointment was initially created",
"definition" : "The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.",
"comment" : "This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.authoredOn"
},
{
"identity" : "rim",
"map" : ".author.time"
},
{
"identity" : "ical",
"map" : "CREATED"
}]
},
{
"id" : "Appointment.comment",
"path" : "Appointment.comment",
"short" : "Additional comments",
"definition" : "Additional comments about the appointment.",
"comment" : "Additional text to aid in facilitating the appointment. For instance, a comment might be, \"patient should proceed immediately to infusion room upon arrival\"\r\rWhere this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.note"
},
{
"identity" : "v2",
"map" : "NTE-3"
},
{
"identity" : "rim",
"map" : ".subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value"
},
{
"identity" : "ical",
"map" : "DESCRIPTION (for internal use)"
}]
},
{
"id" : "Appointment.patientInstruction",
"path" : "Appointment.patientInstruction",
"short" : "Detailed information and instructions for the patient",
"definition" : "While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "v2",
"map" : "NTE-3"
},
{
"identity" : "rim",
"map" : ".subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value"
},
{
"identity" : "ical",
"map" : "DESCRIPTION (for patient use)"
}]
},
{
"id" : "Appointment.basedOn",
"path" : "Appointment.basedOn",
"short" : "The service request this appointment is allocated to assess",
"definition" : "The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).",
"alias" : ["incomingReferral"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ServiceRequest"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.basedOn"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[@typeCode = 'FLFS'].act[@classCode < 'ActCareProvisionRequestType'][@moodCode = 'RQO']"
}]
},
{
"id" : "Appointment.participant",
"path" : "Appointment.participant",
"short" : "Participants involved in appointment",
"definition" : "List of participants involved in the appointment.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "app-1",
"severity" : "error",
"human" : "Either the type or actor on the participant SHALL be specified",
"expression" : "type.exists() or actor.exists()",
"xpath" : "(exists(f:type) or exists(f:actor))"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performer, Request.subject"
},
{
"identity" : "v2",
"map" : "PID, AIP, AIG, AIL"
},
{
"identity" : "rim",
"map" : "performer | reusableDevice | subject | location"
},
{
"identity" : "ical",
"map" : "ATTENDEE component to be created"
}]
},
{
"id" : "Appointment.participant.type",
"path" : "Appointment.participant.type",
"short" : "Role of participant in the appointment",
"definition" : "Role of participant in the appointment.",
"comment" : "The role of the participant can be used to declare what the actor will be doing in the scope of this appointment.\r\rIf the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning.\r\rThis value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ParticipantType"
}],
"strength" : "extensible",
"description" : "Role of participant in encounter.",
"valueSet" : "http://hl7.org/fhir/ValueSet/encounter-participant-type"
},
"mapping" : [{
"identity" : "v2",
"map" : "AIP-4, AIG-4"
},
{
"identity" : "rim",
"map" : "(performer | reusableDevice | subject | location).@typeCode"
},
{
"identity" : "ical",
"map" : "n/a"
}]
},
{
"id" : "Appointment.participant.actor",
"path" : "Appointment.participant.actor",
"short" : "Person, Location/HealthcareService or Device",
"definition" : "A Person, Location/HealthcareService or Device that is participating in the appointment.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Location"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.who"
},
{
"identity" : "v2",
"map" : "PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3"
},
{
"identity" : "rim",
"map" : "performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation"
},
{
"identity" : "ical",
"map" : "ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not \"information-only\""
}]
},
{
"id" : "Appointment.participant.required",
"path" : "Appointment.participant.required",
"short" : "required | optional | information-only",
"definition" : "Whether this participant is required to be present at the meeting. This covers a use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ParticipantRequired"
}],
"strength" : "required",
"description" : "Is the Participant required to attend the appointment.",
"valueSet" : "http://hl7.org/fhir/ValueSet/participantrequired|4.0.0"
},
"mapping" : [{
"identity" : "rim",
"map" : "(performer | reusableDevice | subject | location).@performInd"
},
{
"identity" : "ical",
"map" : "ROLE=REQ-PARTICIPANT (roleparam)"
}]
},
{
"id" : "Appointment.participant.status",
"path" : "Appointment.participant.status",
"short" : "accepted | declined | tentative | needs-action",
"definition" : "Participation status of the actor.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ParticipationStatus"
}],
"strength" : "required",
"description" : "The Participation status of an appointment.",
"valueSet" : "http://hl7.org/fhir/ValueSet/participationstatus|4.0.0"
},
"mapping" : [{
"identity" : "v2",
"map" : "AIP-12, AIG-14"
},
{
"identity" : "rim",
"map" : "(performer | reusableDevice | subject | location).statusCode"
},
{
"identity" : "ical",
"map" : "ATTENDEE;CN=\"John Doe\";RSVP=TRUE:mailto:[email protected] (rsvpparam | partstatparam)"
}]
},
{
"id" : "Appointment.participant.period",
"path" : "Appointment.participant.period",
"short" : "Participation period of the actor",
"definition" : "Participation period of the actor.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Appointment.requestedPeriod",
"path" : "Appointment.requestedPeriod",
"short" : "Potential date/time interval(s) requested to allocate the appointment within",
"definition" : "A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.\n\nThe duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.",
"comment" : "This does not introduce a capacity for recurring appointments.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Period"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "v2",
"map" : "ARQ-11"
},
{
"identity" : "rim",
"map" : ".activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')]"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/AppointmentResponse",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "AppointmentResponse",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints AppointmentResponse ITU DomainResource A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
+ Rule: Either the participantType or actor must be specified
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension \r\n identifier Σ 0..* Identifier External Ids for this item
\r\n appointment Σ 1..1 Reference(Appointment) Appointment this response relates to \r\n start 0..1 instant Time from appointment, or requested new start time \r\n end 0..1 instant Time from appointment, or requested new end time \r\n participantType Σ 0..* CodeableConcept Role of participant in the appointment
Participant type (Extensible)
\r\n actor Σ 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) Person, Location, HealthcareService, or Device \r\n participantStatus ?!Σ 1..1 code accepted | declined | tentative | in-process | completed | needs-action | entered-in-error
ParticipationStatus (Required) \r\n comment 0..1 string Additional comments \r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Base.Workflow"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pa"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/AppointmentResponse",
"version" : "4.0.0",
"name" : "AppointmentResponse",
"status" : "draft",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (Patient Administration)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/pafm/index.cfm"
}]
}],
"description" : "A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "ical",
"uri" : "http://ietf.org/rfc/2445",
"name" : "iCalendar"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "AppointmentResponse",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "AppointmentResponse",
"path" : "AppointmentResponse",
"short" : "A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection",
"definition" : "A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AppointmentResponse",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
},
{
"key" : "apr-1",
"severity" : "error",
"human" : "Either the participantType or actor must be specified",
"expression" : "participantType.exists() or actor.exists()",
"xpath" : "(exists(f:participantType) or exists(f:actor))"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Request"
},
{
"identity" : "rim",
"map" : "Appointment[@moodCode <= 'PRMS']"
},
{
"identity" : "ical",
"map" : "VEVENT"
}]
},
{
"id" : "AppointmentResponse.id",
"path" : "AppointmentResponse.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "AppointmentResponse.meta",
"path" : "AppointmentResponse.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "AppointmentResponse.implicitRules",
"path" : "AppointmentResponse.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "AppointmentResponse.language",
"path" : "AppointmentResponse.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "AppointmentResponse.text",
"path" : "AppointmentResponse.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "AppointmentResponse.contained",
"path" : "AppointmentResponse.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "AppointmentResponse.extension",
"path" : "AppointmentResponse.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "AppointmentResponse.modifierExtension",
"path" : "AppointmentResponse.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "AppointmentResponse.identifier",
"path" : "AppointmentResponse.identifier",
"short" : "External Ids for this item",
"definition" : "This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AppointmentResponse.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
},
{
"identity" : "ical",
"map" : "UID"
}]
},
{
"id" : "AppointmentResponse.appointment",
"path" : "AppointmentResponse.appointment",
"short" : "Appointment this response relates to",
"definition" : "Appointment that this response is replying to.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AppointmentResponse.appointment",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Appointment"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.basedOn"
},
{
"identity" : "rim",
"map" : "scheduleRequest.ActAppointmentRequest[@moodCode <= 'ARQ']"
}]
},
{
"id" : "AppointmentResponse.start",
"path" : "AppointmentResponse.start",
"short" : "Time from appointment, or requested new start time",
"definition" : "Date/Time that the appointment is to take place, or requested new start time.",
"comment" : "This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the start time.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AppointmentResponse.start",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "instant"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.init"
},
{
"identity" : "rim",
"map" : ".effectiveTime.low"
}]
},
{
"id" : "AppointmentResponse.end",
"path" : "AppointmentResponse.end",
"short" : "Time from appointment, or requested new end time",
"definition" : "This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AppointmentResponse.end",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "instant"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "rim",
"map" : ".effectiveTime.high"
}]
},
{
"id" : "AppointmentResponse.participantType",
"path" : "AppointmentResponse.participantType",
"short" : "Role of participant in the appointment",
"definition" : "Role of participant in the appointment.",
"comment" : "The role of the participant can be used to declare what the actor will be doing in the scope of the referenced appointment.\r\rIf the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning.\r\rThis value SHALL be the same as specified on the referenced Appointment so that they can be matched, and subsequently updated.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AppointmentResponse.participantType",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ParticipantType"
}],
"strength" : "extensible",
"description" : "Role of participant in encounter.",
"valueSet" : "http://hl7.org/fhir/ValueSet/encounter-participant-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performerType"
},
{
"identity" : "rim",
"map" : "(performer | reusableDevice | subject | location).@typeCode"
},
{
"identity" : "ical",
"map" : "n/a"
}]
},
{
"id" : "AppointmentResponse.actor",
"path" : "AppointmentResponse.actor",
"short" : "Person, Location, HealthcareService, or Device",
"definition" : "A Person, Location, HealthcareService, or Device that is participating in the appointment.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AppointmentResponse.actor",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Location"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.who"
},
{
"identity" : "v2",
"map" : "PID-3-Patient ID List"
},
{
"identity" : "rim",
"map" : "performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation"
},
{
"identity" : "ical",
"map" : "ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource)"
}]
},
{
"id" : "AppointmentResponse.participantStatus",
"path" : "AppointmentResponse.participantStatus",
"short" : "accepted | declined | tentative | in-process | completed | needs-action | entered-in-error",
"definition" : "Participation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.",
"comment" : "This element is labeled as a modifier because the status contains the code entered-in-error that marks the participant as not currently valid.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AppointmentResponse.participantStatus",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ParticipantStatus"
}],
"strength" : "required",
"description" : "The Participation status of an appointment.",
"valueSet" : "http://hl7.org/fhir/ValueSet/participationstatus|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status"
},
{
"identity" : "rim",
"map" : "(performer | reusableDevice | subject | location).statusCode"
},
{
"identity" : "ical",
"map" : "ATTENDEE;CN=\"Brian Postlethwaite\";RSVP=TRUE:mailto:[email protected] (rsvpparam | partstatparam)"
}]
},
{
"id" : "AppointmentResponse.comment",
"path" : "AppointmentResponse.comment",
"short" : "Additional comments",
"definition" : "Additional comments about the appointment.",
"comment" : "This comment is particularly important when the responder is declining, tentatively accepting or requesting another time to indicate the reasons why.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AppointmentResponse.comment",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.note"
},
{
"identity" : "rim",
"map" : ".subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value"
},
{
"identity" : "ical",
"map" : "COMMENT"
}]
}]
},
"differential" : {
"element" : [{
"id" : "AppointmentResponse",
"path" : "AppointmentResponse",
"short" : "A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection",
"definition" : "A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "apr-1",
"severity" : "error",
"human" : "Either the participantType or actor must be specified",
"expression" : "participantType.exists() or actor.exists()",
"xpath" : "(exists(f:participantType) or exists(f:actor))"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request"
},
{
"identity" : "rim",
"map" : "Appointment[@moodCode <= 'PRMS']"
},
{
"identity" : "ical",
"map" : "VEVENT"
}]
},
{
"id" : "AppointmentResponse.identifier",
"path" : "AppointmentResponse.identifier",
"short" : "External Ids for this item",
"definition" : "This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
},
{
"identity" : "ical",
"map" : "UID"
}]
},
{
"id" : "AppointmentResponse.appointment",
"path" : "AppointmentResponse.appointment",
"short" : "Appointment this response relates to",
"definition" : "Appointment that this response is replying to.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Appointment"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.basedOn"
},
{
"identity" : "rim",
"map" : "scheduleRequest.ActAppointmentRequest[@moodCode <= 'ARQ']"
}]
},
{
"id" : "AppointmentResponse.start",
"path" : "AppointmentResponse.start",
"short" : "Time from appointment, or requested new start time",
"definition" : "Date/Time that the appointment is to take place, or requested new start time.",
"comment" : "This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the start time.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "instant"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.init"
},
{
"identity" : "rim",
"map" : ".effectiveTime.low"
}]
},
{
"id" : "AppointmentResponse.end",
"path" : "AppointmentResponse.end",
"short" : "Time from appointment, or requested new end time",
"definition" : "This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "instant"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "rim",
"map" : ".effectiveTime.high"
}]
},
{
"id" : "AppointmentResponse.participantType",
"path" : "AppointmentResponse.participantType",
"short" : "Role of participant in the appointment",
"definition" : "Role of participant in the appointment.",
"comment" : "The role of the participant can be used to declare what the actor will be doing in the scope of the referenced appointment.\r\rIf the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning.\r\rThis value SHALL be the same as specified on the referenced Appointment so that they can be matched, and subsequently updated.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ParticipantType"
}],
"strength" : "extensible",
"description" : "Role of participant in encounter.",
"valueSet" : "http://hl7.org/fhir/ValueSet/encounter-participant-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performerType"
},
{
"identity" : "rim",
"map" : "(performer | reusableDevice | subject | location).@typeCode"
},
{
"identity" : "ical",
"map" : "n/a"
}]
},
{
"id" : "AppointmentResponse.actor",
"path" : "AppointmentResponse.actor",
"short" : "Person, Location, HealthcareService, or Device",
"definition" : "A Person, Location, HealthcareService, or Device that is participating in the appointment.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Location"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.who"
},
{
"identity" : "v2",
"map" : "PID-3-Patient ID List"
},
{
"identity" : "rim",
"map" : "performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation"
},
{
"identity" : "ical",
"map" : "ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource)"
}]
},
{
"id" : "AppointmentResponse.participantStatus",
"path" : "AppointmentResponse.participantStatus",
"short" : "accepted | declined | tentative | in-process | completed | needs-action | entered-in-error",
"definition" : "Participation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.",
"comment" : "This element is labeled as a modifier because the status contains the code entered-in-error that marks the participant as not currently valid.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ParticipantStatus"
}],
"strength" : "required",
"description" : "The Participation status of an appointment.",
"valueSet" : "http://hl7.org/fhir/ValueSet/participationstatus|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status"
},
{
"identity" : "rim",
"map" : "(performer | reusableDevice | subject | location).statusCode"
},
{
"identity" : "ical",
"map" : "ATTENDEE;CN=\"Brian Postlethwaite\";RSVP=TRUE:mailto:[email protected] (rsvpparam | partstatparam)"
}]
},
{
"id" : "AppointmentResponse.comment",
"path" : "AppointmentResponse.comment",
"short" : "Additional comments",
"definition" : "Additional comments about the appointment.",
"comment" : "This comment is particularly important when the responder is declining, tentatively accepting or requesting another time to indicate the reasons why.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.note"
},
{
"identity" : "rim",
"map" : ".subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value"
},
{
"identity" : "ical",
"map" : "COMMENT"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/AuditEvent",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "AuditEvent",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints AuditEvent TU DomainResource Event record kept for security purposes
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension \r\n type Σ 1..1 Coding Type/identifier of event
Audit Event ID (Extensible) \r\n subtype Σ 0..* Coding More specific type/id for the event
Audit Event Sub-Type (Extensible)
\r\n action Σ 0..1 code Type of action performed during the event
AuditEventAction (Required) \r\n period 0..1 Period When the activity occurred \r\n recorded Σ 1..1 instant Time when the event was recorded \r\n outcome Σ 0..1 code Whether the event succeeded or failed
AuditEventOutcome (Required) \r\n outcomeDesc Σ 0..1 string Description of the event outcome \r\n purposeOfEvent Σ 0..* CodeableConcept The purposeOfUse of the event
V3 Value SetPurposeOfUse (Extensible)
\r\n agent 1..* BackboneElement Actor involved in the event
\r\n type 0..1 CodeableConcept How agent participated
ParticipationRoleType (Extensible) \r\n role 0..* CodeableConcept Agent role in the event
SecurityRoleType (Example)
\r\n who Σ 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who \r\n altId 0..1 string Alternative User identity \r\n name 0..1 string Human friendly name for the agent \r\n requestor Σ 1..1 boolean Whether user is initiator \r\n location 0..1 Reference(Location) Where \r\n policy 0..* uri Policy that authorized event
\r\n media 0..1 Coding Type of media
Media Type Code (Extensible) \r\n network 0..1 BackboneElement Logical network location for application activity \r\n address 0..1 string Identifier for the network access point of the user device \r\n type 0..1 code The type of network access point
AuditEventAgentNetworkType (Required) \r\n purposeOfUse 0..* CodeableConcept Reason given for this user
V3 Value SetPurposeOfUse (Extensible)
\r\n source 1..1 BackboneElement Audit Event Reporter \r\n site 0..1 string Logical source location within the enterprise \r\n observer Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event \r\n type 0..* Coding The type of source where event originated
Audit Event Source Type (Extensible)
\r\n entity I 0..* BackboneElement Data or objects used
+ Rule: Either a name or a query (NOT both)
\r\n what Σ 0..1 Reference(Any) Specific instance of resource \r\n type 0..1 Coding Type of entity involved
Audit event entity type (Extensible) \r\n role 0..1 Coding What role the entity played
AuditEventEntityRole (Extensible) \r\n lifecycle 0..1 Coding Life-cycle stage for the entity
ObjectLifecycleEvents (Extensible) \r\n securityLabel 0..* Coding Security labels on the entity
SecurityLabels (Extensible)
\r\n name ΣI 0..1 string Descriptor for entity \r\n description 0..1 string Descriptive text \r\n query ΣI 0..1 base64Binary Query parameters \r\n detail 0..* BackboneElement Additional Information about the entity
\r\n type 1..1 string Name of the property \r\n value[x] 1..1 Property value \r\n valueString string \r\n valueBase64Binary base64Binary \r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Security"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "not-classified"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "sec"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/AuditEvent",
"version" : "4.0.0",
"name" : "AuditEvent",
"status" : "draft",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (Security)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/secure/index.cfm"
}]
}],
"description" : "A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "dicom",
"uri" : "http://nema.org/dicom",
"name" : "DICOM Tag Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "w3c.prov",
"uri" : "http://www.w3.org/ns/prov",
"name" : "W3C PROV"
},
{
"identity" : "fhirprovenance",
"uri" : "http://hl7.org/fhir/provenance",
"name" : "FHIR Provenance Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "AuditEvent",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "AuditEvent",
"path" : "AuditEvent",
"short" : "Event record kept for security purposes",
"definition" : "A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.",
"comment" : "Based on IHE-ATNA.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AuditEvent",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "rim",
"map" : "ControlAct[moodCode=EVN]"
},
{
"identity" : "dicom",
"map" : "Message"
}]
},
{
"id" : "AuditEvent.id",
"path" : "AuditEvent.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "AuditEvent.meta",
"path" : "AuditEvent.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "AuditEvent.implicitRules",
"path" : "AuditEvent.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "AuditEvent.language",
"path" : "AuditEvent.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "AuditEvent.text",
"path" : "AuditEvent.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "AuditEvent.contained",
"path" : "AuditEvent.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "AuditEvent.extension",
"path" : "AuditEvent.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "AuditEvent.modifierExtension",
"path" : "AuditEvent.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "AuditEvent.type",
"path" : "AuditEvent.type",
"short" : "Type/identifier of event",
"definition" : "Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function.",
"requirements" : "This identifies the performed function. For \"Execute\" Event Action Code audit records, this identifies the application function performed.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AuditEvent.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Coding"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditEventType"
}],
"strength" : "extensible",
"description" : "Type of event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/audit-event-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".code (type, subtype and action are pre-coordinated or sent as translations)"
},
{
"identity" : "dicom",
"map" : "EventId"
},
{
"identity" : "w3c.prov",
"map" : "Activity"
}]
},
{
"id" : "AuditEvent.subtype",
"path" : "AuditEvent.subtype",
"short" : "More specific type/id for the event",
"definition" : "Identifier for the category of event.",
"requirements" : "This field enables queries of messages by implementation-defined event categories.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AuditEvent.subtype",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Coding"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditEventSubType"
}],
"strength" : "extensible",
"description" : "Sub-type of event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/audit-event-sub-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".code (type, subtype and action are pre-coordinated or sent as translations)"
},
{
"identity" : "dicom",
"map" : "EventTypeCode"
}]
},
{
"id" : "AuditEvent.action",
"path" : "AuditEvent.action",
"short" : "Type of action performed during the event",
"definition" : "Indicator for type of action performed during the event that generated the audit.",
"requirements" : "This broadly indicates what kind of action was done on the AuditEvent.entity by the AuditEvent.agent.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AuditEvent.action",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditEventAction"
}],
"strength" : "required",
"description" : "Indicator for type of action performed during the event that generated the event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/audit-event-action|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".code (type, subtype and action are pre-coordinated or sent as translations)"
},
{
"identity" : "dicom",
"map" : "EventActionCode"
}]
},
{
"id" : "AuditEvent.period",
"path" : "AuditEvent.period",
"short" : "When the activity occurred",
"definition" : "The period during which the activity occurred.",
"comment" : "The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AuditEvent.period",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurred[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "rim",
"map" : "./effectiveTime[type=IVL_TS]"
},
{
"identity" : "dicom",
"map" : "EventDateTime"
},
{
"identity" : "w3c.prov",
"map" : "Activity.startTime & Activity.endTime"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.occurred[x]"
}]
},
{
"id" : "AuditEvent.recorded",
"path" : "AuditEvent.recorded",
"short" : "Time when the event was recorded",
"definition" : "The time when the event was recorded.",
"comment" : "In a distributed system, some sort of common time base (e.g. an NTP [RFC1305] server) is a good implementation tactic.",
"requirements" : "This ties an event to a specific date and time. Security audits typically require a consistent time base (e.g. UTC), to eliminate time-zone issues arising from geographical distribution.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AuditEvent.recorded",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "instant"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
},
{
"identity" : "w3c.prov",
"map" : "Activity.when"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.recorded"
}]
},
{
"id" : "AuditEvent.outcome",
"path" : "AuditEvent.outcome",
"short" : "Whether the event succeeded or failed",
"definition" : "Indicates whether the event succeeded or failed.",
"comment" : "In some cases a \"success\" may be partial, for example, an incomplete or interrupted transfer of a radiological study. For the purpose of establishing accountability, these distinctions are not relevant.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AuditEvent.outcome",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditEventOutcome"
}],
"strength" : "required",
"description" : "Indicates whether the event succeeded or failed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".actionNegationInd"
},
{
"identity" : "dicom",
"map" : "EventOutcomeIndicator"
}]
},
{
"id" : "AuditEvent.outcomeDesc",
"path" : "AuditEvent.outcomeDesc",
"short" : "Description of the event outcome",
"definition" : "A free text description of the outcome of the event.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AuditEvent.outcomeDesc",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=OUT].target.text"
},
{
"identity" : "dicom",
"map" : "EventOutcomeDescription"
}]
},
{
"id" : "AuditEvent.purposeOfEvent",
"path" : "AuditEvent.purposeOfEvent",
"short" : "The purposeOfUse of the event",
"definition" : "The purposeOfUse (reason) that was used during the event being recorded.",
"comment" : "Use AuditEvent.agent.purposeOfUse when you know that it is specific to the agent, otherwise use AuditEvent.purposeOfEvent. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AuditEvent.purposeOfEvent",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditPurposeOfUse"
}],
"strength" : "extensible",
"description" : "The reason the activity took place.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-PurposeOfUse"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : "* .reasonCode [ControlActReason when Act.class = CACT Control Act]\n*.outboundRelationship[typeCode=RSON].target"
},
{
"identity" : "dicom",
"map" : "EventPurposeOfUse"
},
{
"identity" : "w3c.prov",
"map" : "Activity.Activity"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.reason, Provenance.activity"
}]
},
{
"id" : "AuditEvent.agent",
"path" : "AuditEvent.agent",
"short" : "Actor involved in the event",
"definition" : "An actor taking an active role in the event or activity that is logged.",
"comment" : "Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity.\n\nFor example, an activity may be initiated by one user for other users or involve more than one user. However, only one user may be the initiator/requestor for the activity.",
"requirements" : "An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility.",
"alias" : ["ActiveParticipant"],
"min" : 1,
"max" : "*",
"base" : {
"path" : "AuditEvent.agent",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.who"
},
{
"identity" : "rim",
"map" : ".participation"
},
{
"identity" : "dicom",
"map" : "ActiveParticipant"
},
{
"identity" : "w3c.prov",
"map" : "Agent"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.agent"
}]
},
{
"id" : "AuditEvent.agent.id",
"path" : "AuditEvent.agent.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "AuditEvent.agent.extension",
"path" : "AuditEvent.agent.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "AuditEvent.agent.modifierExtension",
"path" : "AuditEvent.agent.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "AuditEvent.agent.type",
"path" : "AuditEvent.agent.type",
"short" : "How agent participated",
"definition" : "Specification of the participation type the user plays when performing the event.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AuditEvent.agent.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditAgentType"
}],
"strength" : "extensible",
"description" : "The Participation type of the agent to the event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/participation-role-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.function"
},
{
"identity" : "w5",
"map" : "FiveWs.who"
},
{
"identity" : "rim",
"map" : ".typeCode and/or .functionCode"
},
{
"identity" : "dicom",
"map" : "RoleIdCode"
},
{
"identity" : "w3c.prov",
"map" : "Agent.Attribution"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.agent.type"
}]
},
{
"id" : "AuditEvent.agent.role",
"path" : "AuditEvent.agent.role",
"short" : "Agent role in the event",
"definition" : "The security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context.",
"comment" : "Should be roles relevant to the event. Should not be an exhaustive list of roles.",
"requirements" : "This value ties an audited event to a user's role(s). It is an optional value that might be used to group events for analysis by user functional role categories.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AuditEvent.agent.role",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditAgentRole"
}],
"strength" : "example",
"description" : "What security role enabled the agent to participate in the event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/security-role-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.who"
},
{
"identity" : "rim",
"map" : ".role"
},
{
"identity" : "dicom",
"map" : "RoleIdCode"
},
{
"identity" : "w3c.prov",
"map" : "Agent.Attribution"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.agent.role"
}]
},
{
"id" : "AuditEvent.agent.who",
"path" : "AuditEvent.agent.who",
"short" : "Identifier of who",
"definition" : "Reference to who this agent is that was involved in the event.",
"comment" : "Where a User ID is available it will go into who.identifier.",
"requirements" : "This field ties an audit event to a specific resource or identifier.",
"alias" : ["userId"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "AuditEvent.agent.who",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "w5",
"map" : "FiveWs.who"
},
{
"identity" : "rim",
"map" : ".id"
},
{
"identity" : "dicom",
"map" : "UserId"
},
{
"identity" : "w3c.prov",
"map" : "Agent.Identity"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.agent.who"
}]
},
{
"id" : "AuditEvent.agent.altId",
"path" : "AuditEvent.agent.altId",
"short" : "Alternative User identity",
"definition" : "Alternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available.",
"requirements" : "In some situations, a human user may authenticate with one identity but, to access a specific application system, may use a synonymous identify. For example, some \"single sign on\" implementations will do this. The alternative identifier would then be the original identify used for authentication, and the User ID is the one known to and used by the application.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AuditEvent.agent.altId",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.who"
},
{
"identity" : "rim",
"map" : ".id (distinguish id type by root)"
},
{
"identity" : "dicom",
"map" : "AlternativeUserId"
},
{
"identity" : "w3c.prov",
"map" : "Agent.Identity"
}]
},
{
"id" : "AuditEvent.agent.name",
"path" : "AuditEvent.agent.name",
"short" : "Human friendly name for the agent",
"definition" : "Human-meaningful name for the agent.",
"requirements" : "The User ID and Authorization User ID may be internal or otherwise obscure values. This field assists the auditor in identifying the actual user.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AuditEvent.agent.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.who"
},
{
"identity" : "rim",
"map" : ".name"
},
{
"identity" : "dicom",
"map" : "UserName"
},
{
"identity" : "w3c.prov",
"map" : "Agent.Identity"
}]
},
{
"id" : "AuditEvent.agent.requestor",
"path" : "AuditEvent.agent.requestor",
"short" : "Whether user is initiator",
"definition" : "Indicator that the user is or is not the requestor, or initiator, for the event being audited.",
"comment" : "There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.",
"requirements" : "This value is used to distinguish between requestor-users and recipient-users. For example, one person may initiate a report-output to be sent to another user.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AuditEvent.agent.requestor",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.who"
},
{
"identity" : "rim",
"map" : "If participation.typeCode was author, then true"
},
{
"identity" : "dicom",
"map" : "UserIsRequestor"
}]
},
{
"id" : "AuditEvent.agent.location",
"path" : "AuditEvent.agent.location",
"short" : "Where",
"definition" : "Where the event occurred.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AuditEvent.agent.location",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.location"
},
{
"identity" : "w5",
"map" : "FiveWs.where[x]"
},
{
"identity" : "rim",
"map" : "* Role.Class =SDLOC\n*Role.Code = ServiceDeliveryLocationRoleType\n *Entity.Code = PlaceEntityType = df.Types of places for Entity.Class = PLC\n*EntityClass = PLC = df.A physical place or site with its containing structure. May be natural or man-made. The geographic position of a place might or might not be constant."
},
{
"identity" : "w3c.prov",
"map" : "Activity.location"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.location"
}]
},
{
"id" : "AuditEvent.agent.policy",
"path" : "AuditEvent.agent.policy",
"short" : "Policy that authorized event",
"definition" : "The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.",
"comment" : "For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.",
"requirements" : "This value is used retrospectively to determine the authorization policies.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AuditEvent.agent.policy",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : "ActPolicyType"
},
{
"identity" : "dicom",
"map" : "ParticipantRoleIDCode"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.policy"
}]
},
{
"id" : "AuditEvent.agent.media",
"path" : "AuditEvent.agent.media",
"short" : "Type of media",
"definition" : "Type of media involved. Used when the event is about exporting/importing onto media.",
"requirements" : "Usually, this is used instead of specifying a network address. This field is not used for Media Id (i.e. the serial number of a CD).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AuditEvent.agent.media",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Coding"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DICOMMediaType"
}],
"strength" : "extensible",
"description" : "Used when the event is about exporting/importing onto media.",
"valueSet" : "http://hl7.org/fhir/ValueSet/dicm-405-mediatype"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.where[x]"
},
{
"identity" : "rim",
"map" : ".player.description.mediaType"
},
{
"identity" : "dicom",
"map" : "MediaType"
}]
},
{
"id" : "AuditEvent.agent.network",
"path" : "AuditEvent.agent.network",
"short" : "Logical network location for application activity",
"definition" : "Logical network location for application activity, if the activity has a network location.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AuditEvent.agent.network",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.where[x]"
},
{
"identity" : "rim",
"map" : ".player.description.reference"
}]
},
{
"id" : "AuditEvent.agent.network.id",
"path" : "AuditEvent.agent.network.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "AuditEvent.agent.network.extension",
"path" : "AuditEvent.agent.network.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "AuditEvent.agent.network.modifierExtension",
"path" : "AuditEvent.agent.network.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "AuditEvent.agent.network.address",
"path" : "AuditEvent.agent.network.address",
"short" : "Identifier for the network access point of the user device",
"definition" : "An identifier for the network access point of the user device for the audit event.",
"comment" : "This could be a device id, IP address or some other identifier associated with a device.",
"requirements" : "This datum identifies the user's network access point, which may be distinct from the server that performed the action. It is an optional value that may be used to group events recorded on separate servers for analysis of a specific network access point's data access across all servers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AuditEvent.agent.network.address",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.where[x]"
},
{
"identity" : "rim",
"map" : "pre-coordinated into URL"
},
{
"identity" : "dicom",
"map" : "NetworkAccessPointID"
},
{
"identity" : "w3c.prov",
"map" : "Agent.Location"
}]
},
{
"id" : "AuditEvent.agent.network.type",
"path" : "AuditEvent.agent.network.type",
"short" : "The type of network access point",
"definition" : "An identifier for the type of network access point that originated the audit event.",
"requirements" : "This datum identifies the type of network access point identifier of the user device for the audit event. It is an optional value that may be used to group events recorded on separate servers for analysis of access according to a network access point's type.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AuditEvent.agent.network.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditEventAgentNetworkType"
}],
"strength" : "required",
"description" : "The type of network access point of this agent in the audit event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/network-type|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.where[x]"
},
{
"identity" : "rim",
"map" : "pre-coordinated into URL"
},
{
"identity" : "dicom",
"map" : "NetworkAccessPointTypeCode"
}]
},
{
"id" : "AuditEvent.agent.purposeOfUse",
"path" : "AuditEvent.agent.purposeOfUse",
"short" : "Reason given for this user",
"definition" : "The reason (purpose of use), specific to this agent, that was used during the event being recorded.",
"comment" : "Use AuditEvent.agent.purposeOfUse when you know that is specific to the agent, otherwise use AuditEvent.purposeOfEvent. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AuditEvent.agent.purposeOfUse",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditPurposeOfUse"
}],
"strength" : "extensible",
"description" : "The reason the activity took place.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-PurposeOfUse"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : "*.reasonCode [ActHealthInformationPurposeOfUseReason codes/v:PurposeOfUse\n(2.16.840.1.113883.1.11.20448)\n* .outboundRelationship[typeCode=RSON or SUBJ].target"
},
{
"identity" : "w3c.prov",
"map" : "Agent.Activity"
}]
},
{
"id" : "AuditEvent.source",
"path" : "AuditEvent.source",
"short" : "Audit Event Reporter",
"definition" : "The system that is reporting the event.",
"comment" : "Since multi-tier, distributed, or composite applications make source identification ambiguous, this collection of fields may repeat for each application or process actively involved in the event. For example, multiple value-sets can identify participating web servers, application processes, and database server threads in an n-tier distributed application. Passive event participants (e.g. low-level network transports) need not be identified.",
"requirements" : "The event is reported by one source.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AuditEvent.source",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.witness"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=INF].role[classCode=ASSIGN].player[classCode=DEV, determinerCode=INSTANCE]"
},
{
"identity" : "dicom",
"map" : "AuditSourceIdentification"
}]
},
{
"id" : "AuditEvent.source.id",
"path" : "AuditEvent.source.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "AuditEvent.source.extension",
"path" : "AuditEvent.source.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "AuditEvent.source.modifierExtension",
"path" : "AuditEvent.source.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "AuditEvent.source.site",
"path" : "AuditEvent.source.site",
"short" : "Logical source location within the enterprise",
"definition" : "Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group.",
"requirements" : "This value differentiates among the sites in a multi-site enterprise health information system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AuditEvent.source.site",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.witness"
},
{
"identity" : "rim",
"map" : ".scopedRole[classCode=LOCE].player.desc"
},
{
"identity" : "dicom",
"map" : "AuditEnterpriseSiteId"
}]
},
{
"id" : "AuditEvent.source.observer",
"path" : "AuditEvent.source.observer",
"short" : "The identity of source detecting the event",
"definition" : "Identifier of the source where the event was detected.",
"requirements" : "This field ties the event to a specific source system. It may be used to group events for analysis according to where the event was detected.",
"alias" : ["SourceId"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "AuditEvent.source.observer",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.witness"
},
{
"identity" : "rim",
"map" : ".id"
},
{
"identity" : "dicom",
"map" : "AuditSourceId"
}]
},
{
"id" : "AuditEvent.source.type",
"path" : "AuditEvent.source.type",
"short" : "The type of source where event originated",
"definition" : "Code specifying the type of source where event originated.",
"requirements" : "This field indicates which type of source is identified by the Audit Source ID. It is an optional value that may be used to group events for analysis according to the type of source where the event occurred.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AuditEvent.source.type",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Coding"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditEventSourceType"
}],
"strength" : "extensible",
"description" : "Code specifying the type of system that detected and recorded the event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/audit-source-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.witness"
},
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "dicom",
"map" : "AuditSourceTypeCode"
}]
},
{
"id" : "AuditEvent.entity",
"path" : "AuditEvent.entity",
"short" : "Data or objects used",
"definition" : "Specific instances of data or objects that have been accessed.",
"comment" : "Required unless the values for event identification, agent identification, and audit source identification are sufficient to document the entire auditable event. Because events may have more than one entity, this group can be a repeating set of values.",
"requirements" : "The event may have other entities involved.",
"alias" : ["ParticipantObject"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "AuditEvent.entity",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "sev-1",
"severity" : "error",
"human" : "Either a name or a query (NOT both)",
"expression" : "name.empty() or query.empty()",
"xpath" : "not(exists(f:name)) or not(exists(f:query))"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=SUBJ].target or .participation[typeCode=SBJ].role"
},
{
"identity" : "dicom",
"map" : "ParticipantObjectIdentification"
},
{
"identity" : "w3c.prov",
"map" : "Entity"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.target, Provenance.entity"
}]
},
{
"id" : "AuditEvent.entity.id",
"path" : "AuditEvent.entity.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "AuditEvent.entity.extension",
"path" : "AuditEvent.entity.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "AuditEvent.entity.modifierExtension",
"path" : "AuditEvent.entity.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "AuditEvent.entity.what",
"path" : "AuditEvent.entity.what",
"short" : "Specific instance of resource",
"definition" : "Identifies a specific instance of the entity. The reference should be version specific.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AuditEvent.entity.what",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".id"
},
{
"identity" : "dicom",
"map" : "ParticipantObjectID and ParticipantObjectIDTypeCode"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.target, Provenance.entity.what"
}]
},
{
"id" : "AuditEvent.entity.type",
"path" : "AuditEvent.entity.type",
"short" : "Type of entity involved",
"definition" : "The type of the object that was involved in this audit event.",
"comment" : "This value is distinct from the user's role or any user relationship to the entity.",
"requirements" : "To describe the object being acted upon. In addition to queries on the subject of the action in an auditable event, it is also important to be able to query on the object type for the action.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AuditEvent.entity.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Coding"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditEventEntityType"
}],
"strength" : "extensible",
"description" : "Code for the entity type involved in the audit event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/audit-entity-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : "[self::Act].code or role.player.code"
},
{
"identity" : "dicom",
"map" : "ParticipantObjectTypeCode"
},
{
"identity" : "w3c.prov",
"map" : "Entity.type"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.entity.type"
}]
},
{
"id" : "AuditEvent.entity.role",
"path" : "AuditEvent.entity.role",
"short" : "What role the entity played",
"definition" : "Code representing the role the entity played in the event being audited.",
"requirements" : "For some detailed audit analysis it may be necessary to indicate a more granular type of entity, based on the application role it serves.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AuditEvent.entity.role",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Coding"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditEventEntityRole"
}],
"strength" : "extensible",
"description" : "Code representing the role the entity played in the audit event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/object-role"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : "role.code (not sure what this would mean for an Act)"
},
{
"identity" : "dicom",
"map" : "ParticipantObjectTypeCodeRole"
},
{
"identity" : "w3c.prov",
"map" : "Entity.role"
}]
},
{
"id" : "AuditEvent.entity.lifecycle",
"path" : "AuditEvent.entity.lifecycle",
"short" : "Life-cycle stage for the entity",
"definition" : "Identifier for the data life-cycle stage for the entity.",
"comment" : "This can be used to provide an audit trail for data, over time, as it passes through the system.",
"requirements" : "Institutional policies for privacy and security may optionally fall under different accountability rules based on data life cycle. This provides a differentiating value for those cases.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AuditEvent.entity.lifecycle",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Coding"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditEventEntityLifecycle"
}],
"strength" : "extensible",
"description" : "Identifier for the data life-cycle stage for the entity.",
"valueSet" : "http://hl7.org/fhir/ValueSet/object-lifecycle-events"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : "target of ObservationEvent[code=\"lifecycle\"].value"
},
{
"identity" : "dicom",
"map" : "ParticipantObjectDataLifeCycle"
},
{
"identity" : "w3c.prov",
"map" : "Entity.role"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.entity.role"
}]
},
{
"id" : "AuditEvent.entity.securityLabel",
"path" : "AuditEvent.entity.securityLabel",
"short" : "Security labels on the entity",
"definition" : "Security labels for the identified entity.",
"comment" : "Copied from entity meta security tags.",
"requirements" : "This field identifies the security labels for a specific instance of an object, such as a patient, to detect/track privacy and security issues.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AuditEvent.entity.securityLabel",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Coding"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SecurityLabels"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSet" : "http://hl7.org/fhir/ValueSet/security-labels"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".confidentialityCode"
},
{
"identity" : "dicom",
"map" : "ParticipantObjectSensitivity"
}]
},
{
"id" : "AuditEvent.entity.name",
"path" : "AuditEvent.entity.name",
"short" : "Descriptor for entity",
"definition" : "A name of the entity in the audit event.",
"comment" : "This field may be used in a query/report to identify audit events for a specific person. For example, where multiple synonymous entity identifiers (patient number, medical record number, encounter number, etc.) have been used.",
"requirements" : "Use only where entity can't be identified with an identifier.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AuditEvent.entity.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["sev-1"],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".title"
},
{
"identity" : "dicom",
"map" : "ParticipantObjectName"
},
{
"identity" : "w3c.prov",
"map" : "Entity.Label"
}]
},
{
"id" : "AuditEvent.entity.description",
"path" : "AuditEvent.entity.description",
"short" : "Descriptive text",
"definition" : "Text that describes the entity in more detail.",
"requirements" : "Use only where entity can't be identified with an identifier.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AuditEvent.entity.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".text"
},
{
"identity" : "dicom",
"map" : "ParticipantObjectDescription"
}]
},
{
"id" : "AuditEvent.entity.query",
"path" : "AuditEvent.entity.query",
"short" : "Query parameters",
"definition" : "The query parameters for a query-type entities.",
"comment" : "The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, and AuditEvent.entity.role. The base64 is a general-use and safe container for event specific data blobs regardless of the encoding used by the transaction being recorded. An AuditEvent consuming application must understand the event it is consuming and the formats used by the event. For example, if auditing an Oracle network database access, the Oracle formats must be understood as they will be simply encoded in the base64binary blob.",
"requirements" : "For query events, it may be necessary to capture the actual query input to the query process in order to identify the specific event. Because of differences among query implementations and data encoding for them, this is a base 64 encoded data blob. It may be subsequently decoded or interpreted by downstream audit analysis processing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AuditEvent.entity.query",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "base64Binary"
}],
"condition" : ["sev-1"],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : "No mapping"
},
{
"identity" : "dicom",
"map" : "ParticipantObjectQuery"
}]
},
{
"id" : "AuditEvent.entity.detail",
"path" : "AuditEvent.entity.detail",
"short" : "Additional Information about the entity",
"definition" : "Tagged value pairs for conveying additional information about the entity.",
"requirements" : "Implementation-defined data about specific details of the object accessed or used.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AuditEvent.entity.detail",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN]"
},
{
"identity" : "dicom",
"map" : "ParticipantObjectDetail"
}]
},
{
"id" : "AuditEvent.entity.detail.id",
"path" : "AuditEvent.entity.detail.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "AuditEvent.entity.detail.extension",
"path" : "AuditEvent.entity.detail.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "AuditEvent.entity.detail.modifierExtension",
"path" : "AuditEvent.entity.detail.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "AuditEvent.entity.detail.type",
"path" : "AuditEvent.entity.detail.type",
"short" : "Name of the property",
"definition" : "The type of extra detail provided in the value.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AuditEvent.entity.detail.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "dicom",
"map" : "ParticipantObjectDetail.type"
}]
},
{
"id" : "AuditEvent.entity.detail.value[x]",
"path" : "AuditEvent.entity.detail.value[x]",
"short" : "Property value",
"definition" : "The value of the extra detail.",
"comment" : "The value can be string when known to be a string, else base64 encoding should be used to protect binary or undefined content. The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, and AuditEvent.entity.role. The base64 is a general-use and safe container for event specific data blobs regardless of the encoding used by the transaction being recorded. An AuditEvent consuming application must understand the event it is consuming and the formats used by the event. For example if auditing an Oracle network database access, the Oracle formats must be understood as they will be simply encoded in the base64binary blob.",
"requirements" : "Should not duplicate the entity value unless absolutely necessary.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AuditEvent.entity.detail.value[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
},
{
"code" : "base64Binary"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".value"
},
{
"identity" : "dicom",
"map" : "ParticipantObjectDetail.value"
}]
}]
},
"differential" : {
"element" : [{
"id" : "AuditEvent",
"path" : "AuditEvent",
"short" : "Event record kept for security purposes",
"definition" : "A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.",
"comment" : "Based on IHE-ATNA.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "rim",
"map" : "ControlAct[moodCode=EVN]"
},
{
"identity" : "dicom",
"map" : "Message"
}]
},
{
"id" : "AuditEvent.type",
"path" : "AuditEvent.type",
"short" : "Type/identifier of event",
"definition" : "Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function.",
"requirements" : "This identifies the performed function. For \"Execute\" Event Action Code audit records, this identifies the application function performed.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Coding"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditEventType"
}],
"strength" : "extensible",
"description" : "Type of event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/audit-event-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".code (type, subtype and action are pre-coordinated or sent as translations)"
},
{
"identity" : "dicom",
"map" : "EventId"
},
{
"identity" : "w3c.prov",
"map" : "Activity"
}]
},
{
"id" : "AuditEvent.subtype",
"path" : "AuditEvent.subtype",
"short" : "More specific type/id for the event",
"definition" : "Identifier for the category of event.",
"requirements" : "This field enables queries of messages by implementation-defined event categories.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Coding"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditEventSubType"
}],
"strength" : "extensible",
"description" : "Sub-type of event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/audit-event-sub-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".code (type, subtype and action are pre-coordinated or sent as translations)"
},
{
"identity" : "dicom",
"map" : "EventTypeCode"
}]
},
{
"id" : "AuditEvent.action",
"path" : "AuditEvent.action",
"short" : "Type of action performed during the event",
"definition" : "Indicator for type of action performed during the event that generated the audit.",
"requirements" : "This broadly indicates what kind of action was done on the AuditEvent.entity by the AuditEvent.agent.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditEventAction"
}],
"strength" : "required",
"description" : "Indicator for type of action performed during the event that generated the event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/audit-event-action|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".code (type, subtype and action are pre-coordinated or sent as translations)"
},
{
"identity" : "dicom",
"map" : "EventActionCode"
}]
},
{
"id" : "AuditEvent.period",
"path" : "AuditEvent.period",
"short" : "When the activity occurred",
"definition" : "The period during which the activity occurred.",
"comment" : "The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurred[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "rim",
"map" : "./effectiveTime[type=IVL_TS]"
},
{
"identity" : "dicom",
"map" : "EventDateTime"
},
{
"identity" : "w3c.prov",
"map" : "Activity.startTime & Activity.endTime"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.occurred[x]"
}]
},
{
"id" : "AuditEvent.recorded",
"path" : "AuditEvent.recorded",
"short" : "Time when the event was recorded",
"definition" : "The time when the event was recorded.",
"comment" : "In a distributed system, some sort of common time base (e.g. an NTP [RFC1305] server) is a good implementation tactic.",
"requirements" : "This ties an event to a specific date and time. Security audits typically require a consistent time base (e.g. UTC), to eliminate time-zone issues arising from geographical distribution.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "instant"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
},
{
"identity" : "w3c.prov",
"map" : "Activity.when"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.recorded"
}]
},
{
"id" : "AuditEvent.outcome",
"path" : "AuditEvent.outcome",
"short" : "Whether the event succeeded or failed",
"definition" : "Indicates whether the event succeeded or failed.",
"comment" : "In some cases a \"success\" may be partial, for example, an incomplete or interrupted transfer of a radiological study. For the purpose of establishing accountability, these distinctions are not relevant.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditEventOutcome"
}],
"strength" : "required",
"description" : "Indicates whether the event succeeded or failed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".actionNegationInd"
},
{
"identity" : "dicom",
"map" : "EventOutcomeIndicator"
}]
},
{
"id" : "AuditEvent.outcomeDesc",
"path" : "AuditEvent.outcomeDesc",
"short" : "Description of the event outcome",
"definition" : "A free text description of the outcome of the event.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=OUT].target.text"
},
{
"identity" : "dicom",
"map" : "EventOutcomeDescription"
}]
},
{
"id" : "AuditEvent.purposeOfEvent",
"path" : "AuditEvent.purposeOfEvent",
"short" : "The purposeOfUse of the event",
"definition" : "The purposeOfUse (reason) that was used during the event being recorded.",
"comment" : "Use AuditEvent.agent.purposeOfUse when you know that it is specific to the agent, otherwise use AuditEvent.purposeOfEvent. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditPurposeOfUse"
}],
"strength" : "extensible",
"description" : "The reason the activity took place.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-PurposeOfUse"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : "* .reasonCode [ControlActReason when Act.class = CACT Control Act]\n*.outboundRelationship[typeCode=RSON].target"
},
{
"identity" : "dicom",
"map" : "EventPurposeOfUse"
},
{
"identity" : "w3c.prov",
"map" : "Activity.Activity"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.reason, Provenance.activity"
}]
},
{
"id" : "AuditEvent.agent",
"path" : "AuditEvent.agent",
"short" : "Actor involved in the event",
"definition" : "An actor taking an active role in the event or activity that is logged.",
"comment" : "Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity.\n\nFor example, an activity may be initiated by one user for other users or involve more than one user. However, only one user may be the initiator/requestor for the activity.",
"requirements" : "An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility.",
"alias" : ["ActiveParticipant"],
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.who"
},
{
"identity" : "rim",
"map" : ".participation"
},
{
"identity" : "dicom",
"map" : "ActiveParticipant"
},
{
"identity" : "w3c.prov",
"map" : "Agent"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.agent"
}]
},
{
"id" : "AuditEvent.agent.type",
"path" : "AuditEvent.agent.type",
"short" : "How agent participated",
"definition" : "Specification of the participation type the user plays when performing the event.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditAgentType"
}],
"strength" : "extensible",
"description" : "The Participation type of the agent to the event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/participation-role-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.function"
},
{
"identity" : "w5",
"map" : "FiveWs.who"
},
{
"identity" : "rim",
"map" : ".typeCode and/or .functionCode"
},
{
"identity" : "dicom",
"map" : "RoleIdCode"
},
{
"identity" : "w3c.prov",
"map" : "Agent.Attribution"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.agent.type"
}]
},
{
"id" : "AuditEvent.agent.role",
"path" : "AuditEvent.agent.role",
"short" : "Agent role in the event",
"definition" : "The security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context.",
"comment" : "Should be roles relevant to the event. Should not be an exhaustive list of roles.",
"requirements" : "This value ties an audited event to a user's role(s). It is an optional value that might be used to group events for analysis by user functional role categories.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditAgentRole"
}],
"strength" : "example",
"description" : "What security role enabled the agent to participate in the event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/security-role-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.who"
},
{
"identity" : "rim",
"map" : ".role"
},
{
"identity" : "dicom",
"map" : "RoleIdCode"
},
{
"identity" : "w3c.prov",
"map" : "Agent.Attribution"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.agent.role"
}]
},
{
"id" : "AuditEvent.agent.who",
"path" : "AuditEvent.agent.who",
"short" : "Identifier of who",
"definition" : "Reference to who this agent is that was involved in the event.",
"comment" : "Where a User ID is available it will go into who.identifier.",
"requirements" : "This field ties an audit event to a specific resource or identifier.",
"alias" : ["userId"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "w5",
"map" : "FiveWs.who"
},
{
"identity" : "rim",
"map" : ".id"
},
{
"identity" : "dicom",
"map" : "UserId"
},
{
"identity" : "w3c.prov",
"map" : "Agent.Identity"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.agent.who"
}]
},
{
"id" : "AuditEvent.agent.altId",
"path" : "AuditEvent.agent.altId",
"short" : "Alternative User identity",
"definition" : "Alternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available.",
"requirements" : "In some situations, a human user may authenticate with one identity but, to access a specific application system, may use a synonymous identify. For example, some \"single sign on\" implementations will do this. The alternative identifier would then be the original identify used for authentication, and the User ID is the one known to and used by the application.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.who"
},
{
"identity" : "rim",
"map" : ".id (distinguish id type by root)"
},
{
"identity" : "dicom",
"map" : "AlternativeUserId"
},
{
"identity" : "w3c.prov",
"map" : "Agent.Identity"
}]
},
{
"id" : "AuditEvent.agent.name",
"path" : "AuditEvent.agent.name",
"short" : "Human friendly name for the agent",
"definition" : "Human-meaningful name for the agent.",
"requirements" : "The User ID and Authorization User ID may be internal or otherwise obscure values. This field assists the auditor in identifying the actual user.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.who"
},
{
"identity" : "rim",
"map" : ".name"
},
{
"identity" : "dicom",
"map" : "UserName"
},
{
"identity" : "w3c.prov",
"map" : "Agent.Identity"
}]
},
{
"id" : "AuditEvent.agent.requestor",
"path" : "AuditEvent.agent.requestor",
"short" : "Whether user is initiator",
"definition" : "Indicator that the user is or is not the requestor, or initiator, for the event being audited.",
"comment" : "There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.",
"requirements" : "This value is used to distinguish between requestor-users and recipient-users. For example, one person may initiate a report-output to be sent to another user.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.who"
},
{
"identity" : "rim",
"map" : "If participation.typeCode was author, then true"
},
{
"identity" : "dicom",
"map" : "UserIsRequestor"
}]
},
{
"id" : "AuditEvent.agent.location",
"path" : "AuditEvent.agent.location",
"short" : "Where",
"definition" : "Where the event occurred.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.location"
},
{
"identity" : "w5",
"map" : "FiveWs.where[x]"
},
{
"identity" : "rim",
"map" : "* Role.Class =SDLOC\n*Role.Code = ServiceDeliveryLocationRoleType\n *Entity.Code = PlaceEntityType = df.Types of places for Entity.Class = PLC\n*EntityClass = PLC = df.A physical place or site with its containing structure. May be natural or man-made. The geographic position of a place might or might not be constant."
},
{
"identity" : "w3c.prov",
"map" : "Activity.location"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.location"
}]
},
{
"id" : "AuditEvent.agent.policy",
"path" : "AuditEvent.agent.policy",
"short" : "Policy that authorized event",
"definition" : "The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.",
"comment" : "For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.",
"requirements" : "This value is used retrospectively to determine the authorization policies.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "uri"
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : "ActPolicyType"
},
{
"identity" : "dicom",
"map" : "ParticipantRoleIDCode"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.policy"
}]
},
{
"id" : "AuditEvent.agent.media",
"path" : "AuditEvent.agent.media",
"short" : "Type of media",
"definition" : "Type of media involved. Used when the event is about exporting/importing onto media.",
"requirements" : "Usually, this is used instead of specifying a network address. This field is not used for Media Id (i.e. the serial number of a CD).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Coding"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DICOMMediaType"
}],
"strength" : "extensible",
"description" : "Used when the event is about exporting/importing onto media.",
"valueSet" : "http://hl7.org/fhir/ValueSet/dicm-405-mediatype"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.where[x]"
},
{
"identity" : "rim",
"map" : ".player.description.mediaType"
},
{
"identity" : "dicom",
"map" : "MediaType"
}]
},
{
"id" : "AuditEvent.agent.network",
"path" : "AuditEvent.agent.network",
"short" : "Logical network location for application activity",
"definition" : "Logical network location for application activity, if the activity has a network location.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.where[x]"
},
{
"identity" : "rim",
"map" : ".player.description.reference"
}]
},
{
"id" : "AuditEvent.agent.network.address",
"path" : "AuditEvent.agent.network.address",
"short" : "Identifier for the network access point of the user device",
"definition" : "An identifier for the network access point of the user device for the audit event.",
"comment" : "This could be a device id, IP address or some other identifier associated with a device.",
"requirements" : "This datum identifies the user's network access point, which may be distinct from the server that performed the action. It is an optional value that may be used to group events recorded on separate servers for analysis of a specific network access point's data access across all servers.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.where[x]"
},
{
"identity" : "rim",
"map" : "pre-coordinated into URL"
},
{
"identity" : "dicom",
"map" : "NetworkAccessPointID"
},
{
"identity" : "w3c.prov",
"map" : "Agent.Location"
}]
},
{
"id" : "AuditEvent.agent.network.type",
"path" : "AuditEvent.agent.network.type",
"short" : "The type of network access point",
"definition" : "An identifier for the type of network access point that originated the audit event.",
"requirements" : "This datum identifies the type of network access point identifier of the user device for the audit event. It is an optional value that may be used to group events recorded on separate servers for analysis of access according to a network access point's type.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditEventAgentNetworkType"
}],
"strength" : "required",
"description" : "The type of network access point of this agent in the audit event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/network-type|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.where[x]"
},
{
"identity" : "rim",
"map" : "pre-coordinated into URL"
},
{
"identity" : "dicom",
"map" : "NetworkAccessPointTypeCode"
}]
},
{
"id" : "AuditEvent.agent.purposeOfUse",
"path" : "AuditEvent.agent.purposeOfUse",
"short" : "Reason given for this user",
"definition" : "The reason (purpose of use), specific to this agent, that was used during the event being recorded.",
"comment" : "Use AuditEvent.agent.purposeOfUse when you know that is specific to the agent, otherwise use AuditEvent.purposeOfEvent. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditPurposeOfUse"
}],
"strength" : "extensible",
"description" : "The reason the activity took place.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-PurposeOfUse"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : "*.reasonCode [ActHealthInformationPurposeOfUseReason codes/v:PurposeOfUse\n(2.16.840.1.113883.1.11.20448)\n* .outboundRelationship[typeCode=RSON or SUBJ].target"
},
{
"identity" : "w3c.prov",
"map" : "Agent.Activity"
}]
},
{
"id" : "AuditEvent.source",
"path" : "AuditEvent.source",
"short" : "Audit Event Reporter",
"definition" : "The system that is reporting the event.",
"comment" : "Since multi-tier, distributed, or composite applications make source identification ambiguous, this collection of fields may repeat for each application or process actively involved in the event. For example, multiple value-sets can identify participating web servers, application processes, and database server threads in an n-tier distributed application. Passive event participants (e.g. low-level network transports) need not be identified.",
"requirements" : "The event is reported by one source.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.witness"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=INF].role[classCode=ASSIGN].player[classCode=DEV, determinerCode=INSTANCE]"
},
{
"identity" : "dicom",
"map" : "AuditSourceIdentification"
}]
},
{
"id" : "AuditEvent.source.site",
"path" : "AuditEvent.source.site",
"short" : "Logical source location within the enterprise",
"definition" : "Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group.",
"requirements" : "This value differentiates among the sites in a multi-site enterprise health information system.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.witness"
},
{
"identity" : "rim",
"map" : ".scopedRole[classCode=LOCE].player.desc"
},
{
"identity" : "dicom",
"map" : "AuditEnterpriseSiteId"
}]
},
{
"id" : "AuditEvent.source.observer",
"path" : "AuditEvent.source.observer",
"short" : "The identity of source detecting the event",
"definition" : "Identifier of the source where the event was detected.",
"requirements" : "This field ties the event to a specific source system. It may be used to group events for analysis according to where the event was detected.",
"alias" : ["SourceId"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.witness"
},
{
"identity" : "rim",
"map" : ".id"
},
{
"identity" : "dicom",
"map" : "AuditSourceId"
}]
},
{
"id" : "AuditEvent.source.type",
"path" : "AuditEvent.source.type",
"short" : "The type of source where event originated",
"definition" : "Code specifying the type of source where event originated.",
"requirements" : "This field indicates which type of source is identified by the Audit Source ID. It is an optional value that may be used to group events for analysis according to the type of source where the event occurred.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Coding"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditEventSourceType"
}],
"strength" : "extensible",
"description" : "Code specifying the type of system that detected and recorded the event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/audit-source-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.witness"
},
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "dicom",
"map" : "AuditSourceTypeCode"
}]
},
{
"id" : "AuditEvent.entity",
"path" : "AuditEvent.entity",
"short" : "Data or objects used",
"definition" : "Specific instances of data or objects that have been accessed.",
"comment" : "Required unless the values for event identification, agent identification, and audit source identification are sufficient to document the entire auditable event. Because events may have more than one entity, this group can be a repeating set of values.",
"requirements" : "The event may have other entities involved.",
"alias" : ["ParticipantObject"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "sev-1",
"severity" : "error",
"human" : "Either a name or a query (NOT both)",
"expression" : "name.empty() or query.empty()",
"xpath" : "not(exists(f:name)) or not(exists(f:query))"
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=SUBJ].target or .participation[typeCode=SBJ].role"
},
{
"identity" : "dicom",
"map" : "ParticipantObjectIdentification"
},
{
"identity" : "w3c.prov",
"map" : "Entity"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.target, Provenance.entity"
}]
},
{
"id" : "AuditEvent.entity.what",
"path" : "AuditEvent.entity.what",
"short" : "Specific instance of resource",
"definition" : "Identifies a specific instance of the entity. The reference should be version specific.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".id"
},
{
"identity" : "dicom",
"map" : "ParticipantObjectID and ParticipantObjectIDTypeCode"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.target, Provenance.entity.what"
}]
},
{
"id" : "AuditEvent.entity.type",
"path" : "AuditEvent.entity.type",
"short" : "Type of entity involved",
"definition" : "The type of the object that was involved in this audit event.",
"comment" : "This value is distinct from the user's role or any user relationship to the entity.",
"requirements" : "To describe the object being acted upon. In addition to queries on the subject of the action in an auditable event, it is also important to be able to query on the object type for the action.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Coding"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditEventEntityType"
}],
"strength" : "extensible",
"description" : "Code for the entity type involved in the audit event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/audit-entity-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : "[self::Act].code or role.player.code"
},
{
"identity" : "dicom",
"map" : "ParticipantObjectTypeCode"
},
{
"identity" : "w3c.prov",
"map" : "Entity.type"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.entity.type"
}]
},
{
"id" : "AuditEvent.entity.role",
"path" : "AuditEvent.entity.role",
"short" : "What role the entity played",
"definition" : "Code representing the role the entity played in the event being audited.",
"requirements" : "For some detailed audit analysis it may be necessary to indicate a more granular type of entity, based on the application role it serves.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Coding"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditEventEntityRole"
}],
"strength" : "extensible",
"description" : "Code representing the role the entity played in the audit event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/object-role"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : "role.code (not sure what this would mean for an Act)"
},
{
"identity" : "dicom",
"map" : "ParticipantObjectTypeCodeRole"
},
{
"identity" : "w3c.prov",
"map" : "Entity.role"
}]
},
{
"id" : "AuditEvent.entity.lifecycle",
"path" : "AuditEvent.entity.lifecycle",
"short" : "Life-cycle stage for the entity",
"definition" : "Identifier for the data life-cycle stage for the entity.",
"comment" : "This can be used to provide an audit trail for data, over time, as it passes through the system.",
"requirements" : "Institutional policies for privacy and security may optionally fall under different accountability rules based on data life cycle. This provides a differentiating value for those cases.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Coding"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuditEventEntityLifecycle"
}],
"strength" : "extensible",
"description" : "Identifier for the data life-cycle stage for the entity.",
"valueSet" : "http://hl7.org/fhir/ValueSet/object-lifecycle-events"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : "target of ObservationEvent[code=\"lifecycle\"].value"
},
{
"identity" : "dicom",
"map" : "ParticipantObjectDataLifeCycle"
},
{
"identity" : "w3c.prov",
"map" : "Entity.role"
},
{
"identity" : "fhirprovenance",
"map" : "Provenance.entity.role"
}]
},
{
"id" : "AuditEvent.entity.securityLabel",
"path" : "AuditEvent.entity.securityLabel",
"short" : "Security labels on the entity",
"definition" : "Security labels for the identified entity.",
"comment" : "Copied from entity meta security tags.",
"requirements" : "This field identifies the security labels for a specific instance of an object, such as a patient, to detect/track privacy and security issues.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Coding"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SecurityLabels"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSet" : "http://hl7.org/fhir/ValueSet/security-labels"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".confidentialityCode"
},
{
"identity" : "dicom",
"map" : "ParticipantObjectSensitivity"
}]
},
{
"id" : "AuditEvent.entity.name",
"path" : "AuditEvent.entity.name",
"short" : "Descriptor for entity",
"definition" : "A name of the entity in the audit event.",
"comment" : "This field may be used in a query/report to identify audit events for a specific person. For example, where multiple synonymous entity identifiers (patient number, medical record number, encounter number, etc.) have been used.",
"requirements" : "Use only where entity can't be identified with an identifier.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["sev-1"],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".title"
},
{
"identity" : "dicom",
"map" : "ParticipantObjectName"
},
{
"identity" : "w3c.prov",
"map" : "Entity.Label"
}]
},
{
"id" : "AuditEvent.entity.description",
"path" : "AuditEvent.entity.description",
"short" : "Descriptive text",
"definition" : "Text that describes the entity in more detail.",
"requirements" : "Use only where entity can't be identified with an identifier.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".text"
},
{
"identity" : "dicom",
"map" : "ParticipantObjectDescription"
}]
},
{
"id" : "AuditEvent.entity.query",
"path" : "AuditEvent.entity.query",
"short" : "Query parameters",
"definition" : "The query parameters for a query-type entities.",
"comment" : "The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, and AuditEvent.entity.role. The base64 is a general-use and safe container for event specific data blobs regardless of the encoding used by the transaction being recorded. An AuditEvent consuming application must understand the event it is consuming and the formats used by the event. For example, if auditing an Oracle network database access, the Oracle formats must be understood as they will be simply encoded in the base64binary blob.",
"requirements" : "For query events, it may be necessary to capture the actual query input to the query process in order to identify the specific event. Because of differences among query implementations and data encoding for them, this is a base 64 encoded data blob. It may be subsequently decoded or interpreted by downstream audit analysis processing.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "base64Binary"
}],
"condition" : ["sev-1"],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : "No mapping"
},
{
"identity" : "dicom",
"map" : "ParticipantObjectQuery"
}]
},
{
"id" : "AuditEvent.entity.detail",
"path" : "AuditEvent.entity.detail",
"short" : "Additional Information about the entity",
"definition" : "Tagged value pairs for conveying additional information about the entity.",
"requirements" : "Implementation-defined data about specific details of the object accessed or used.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN]"
},
{
"identity" : "dicom",
"map" : "ParticipantObjectDetail"
}]
},
{
"id" : "AuditEvent.entity.detail.type",
"path" : "AuditEvent.entity.detail.type",
"short" : "Name of the property",
"definition" : "The type of extra detail provided in the value.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "dicom",
"map" : "ParticipantObjectDetail.type"
}]
},
{
"id" : "AuditEvent.entity.detail.value[x]",
"path" : "AuditEvent.entity.detail.value[x]",
"short" : "Property value",
"definition" : "The value of the extra detail.",
"comment" : "The value can be string when known to be a string, else base64 encoding should be used to protect binary or undefined content. The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, and AuditEvent.entity.role. The base64 is a general-use and safe container for event specific data blobs regardless of the encoding used by the transaction being recorded. An AuditEvent consuming application must understand the event it is consuming and the formats used by the event. For example if auditing an Oracle network database access, the Oracle formats must be understood as they will be simply encoded in the base64binary blob.",
"requirements" : "Should not duplicate the entity value unless absolutely necessary.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
},
{
"code" : "base64Binary"
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".value"
},
{
"identity" : "dicom",
"map" : "ParticipantObjectDetail.value"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/Basic",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "Basic",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints Basic ΣTU DomainResource Resource for non-supported content
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension \r\n identifier Σ 0..* Identifier Business identifier
\r\n code ?!Σ 1..1 CodeableConcept Kind of Resource
Basic Resource Types (Example) \r\n subject Σ 0..1 Reference(Any) Identifies the focus of this resource \r\n created Σ 0..1 date When created \r\n author Σ 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) Who created \r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Other"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "not-classified"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Basic",
"version" : "4.0.0",
"name" : "Basic",
"status" : "draft",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}]
}],
"description" : "Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.",
"purpose" : "Need some way to safely (without breaking interoperability) allow implementers to exchange content not supported by the initial set of declared resources.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Basic",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Basic",
"path" : "Basic",
"short" : "Resource for non-supported content",
"definition" : "Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.",
"alias" : ["Z-resource",
"Extension-resource",
"Custom-resource"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Basic",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "Act, Entity or Role"
}]
},
{
"id" : "Basic.id",
"path" : "Basic.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Basic.meta",
"path" : "Basic.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Basic.implicitRules",
"path" : "Basic.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Basic.language",
"path" : "Basic.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Basic.text",
"path" : "Basic.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Basic.contained",
"path" : "Basic.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Basic.extension",
"path" : "Basic.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Basic.modifierExtension",
"path" : "Basic.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Basic.identifier",
"path" : "Basic.identifier",
"short" : "Business identifier",
"definition" : "Identifier assigned to the resource for business purposes, outside the context of FHIR.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Basic.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : "./identifier"
}]
},
{
"id" : "Basic.code",
"path" : "Basic.code",
"short" : "Kind of Resource",
"definition" : "Identifies the 'type' of resource - equivalent to the resource name for other resources.",
"comment" : "Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code.\n\nThis element is labeled as a modifier because it defines the meaning of the resource and cannot be ignored.",
"requirements" : "Must be able to distinguish different types of Basic resources.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Basic.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : true,
"isModifierReason" : "This element determines what kind of resource is being represented which drives the meaning of all of the other elements.",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BasicResourceType"
}],
"strength" : "example",
"description" : "Codes for identifying types of resources not yet defined by FHIR.",
"valueSet" : "http://hl7.org/fhir/ValueSet/basic-resource-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : "./code"
}]
},
{
"id" : "Basic.subject",
"path" : "Basic.subject",
"short" : "Identifies the focus of this resource",
"definition" : "Identifies the patient, practitioner, device or any other resource that is the \"focus\" of this resource.",
"comment" : "Optional as not all potential resources will have subjects. Resources associated with multiple subjects can handle this via extension.",
"requirements" : "Needed for partitioning the resource by Patient.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Basic.subject",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "rim",
"map" : "./participation[typeCode='SBJ'] (possibly through a ControlAct and Role)"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Basic.created",
"path" : "Basic.created",
"short" : "When created",
"definition" : "Identifies when the resource was first created.",
"requirements" : "Allows ordering resource instances by time.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Basic.created",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : "./participation[typeCode='AUT']/time (possibly through a ControlAct and Role)"
}]
},
{
"id" : "Basic.author",
"path" : "Basic.author",
"short" : "Who created",
"definition" : "Indicates who was responsible for creating the resource instance.",
"requirements" : "Needed for partitioning the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Basic.author",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "rim",
"map" : "./participation[typeCode='SUB'] (possibly through a ControlAct and Role)"
}]
}]
},
"differential" : {
"element" : [{
"id" : "Basic",
"path" : "Basic",
"short" : "Resource for non-supported content",
"definition" : "Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.",
"alias" : ["Z-resource",
"Extension-resource",
"Custom-resource"],
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "rim",
"map" : "Act, Entity or Role"
}]
},
{
"id" : "Basic.identifier",
"path" : "Basic.identifier",
"short" : "Business identifier",
"definition" : "Identifier assigned to the resource for business purposes, outside the context of FHIR.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : "./identifier"
}]
},
{
"id" : "Basic.code",
"path" : "Basic.code",
"short" : "Kind of Resource",
"definition" : "Identifies the 'type' of resource - equivalent to the resource name for other resources.",
"comment" : "Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code.\n\nThis element is labeled as a modifier because it defines the meaning of the resource and cannot be ignored.",
"requirements" : "Must be able to distinguish different types of Basic resources.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : true,
"isModifierReason" : "This element determines what kind of resource is being represented which drives the meaning of all of the other elements.",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BasicResourceType"
}],
"strength" : "example",
"description" : "Codes for identifying types of resources not yet defined by FHIR.",
"valueSet" : "http://hl7.org/fhir/ValueSet/basic-resource-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : "./code"
}]
},
{
"id" : "Basic.subject",
"path" : "Basic.subject",
"short" : "Identifies the focus of this resource",
"definition" : "Identifies the patient, practitioner, device or any other resource that is the \"focus\" of this resource.",
"comment" : "Optional as not all potential resources will have subjects. Resources associated with multiple subjects can handle this via extension.",
"requirements" : "Needed for partitioning the resource by Patient.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "rim",
"map" : "./participation[typeCode='SBJ'] (possibly through a ControlAct and Role)"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Basic.created",
"path" : "Basic.created",
"short" : "When created",
"definition" : "Identifies when the resource was first created.",
"requirements" : "Allows ordering resource instances by time.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : "./participation[typeCode='AUT']/time (possibly through a ControlAct and Role)"
}]
},
{
"id" : "Basic.author",
"path" : "Basic.author",
"short" : "Who created",
"definition" : "Indicates who was responsible for creating the resource instance.",
"requirements" : "Needed for partitioning the resource.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "rim",
"map" : "./participation[typeCode='SUB'] (possibly through a ControlAct and Role)"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/Binary",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "Binary",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints Binary N Resource Pure binary content defined by a format other than FHIR
Elements defined in Ancestors: id, meta, implicitRules, language \r\n contentType Σ 1..1 code MimeType of the binary content
MimeType (Required) \r\n securityContext Σ 0..1 Reference(Any) Identifies another resource to use as proxy when enforcing access control \r\n data 0..1 base64Binary The actual content \r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Other"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "not-classified"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Binary",
"version" : "4.0.0",
"name" : "Binary",
"status" : "active",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}]
}],
"description" : "A resource that represents the data of a single raw artifact as digital content accessible in its native format. A Binary resource can contain any content, whether text, image, pdf, zip archive, etc.",
"purpose" : "There are situations where it is useful or required to handle pure binary content using the same framework as other resources.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Binary",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Resource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Binary",
"path" : "Binary",
"short" : "Pure binary content defined by a format other than FHIR",
"definition" : "A resource that represents the data of a single raw artifact as digital content accessible in its native format. A Binary resource can contain any content, whether text, image, pdf, zip archive, etc.",
"comment" : "Typically, Binary resources are used for handling content such as: \n\n* CDA Documents (i.e. with XDS) \n* PDF Documents \n* Images (the Media resource is preferred for handling images, but not possible when the content is already binary - e.g. XDS).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Binary",
"min" : 0,
"max" : "*"
},
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "ED"
}]
},
{
"id" : "Binary.id",
"path" : "Binary.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Binary.meta",
"path" : "Binary.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Binary.implicitRules",
"path" : "Binary.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Binary.language",
"path" : "Binary.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Binary.contentType",
"path" : "Binary.contentType",
"short" : "MimeType of the binary content",
"definition" : "MimeType of the binary content represented as a standard MimeType (BCP 13).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Binary.contentType",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MimeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The mime type of an attachment. Any valid mime type is allowed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|4.0.0"
},
"mapping" : [{
"identity" : "rim",
"map" : "ED.mediaType"
}]
},
{
"id" : "Binary.securityContext",
"path" : "Binary.securityContext",
"short" : "Identifies another resource to use as proxy when enforcing access control",
"definition" : "This element identifies another resource that can be used as a proxy of the security sensitivity to use when deciding and enforcing access control rules for the Binary resource. Given that the Binary resource contains very few elements that can be used to determine the sensitivity of the data and relationships to individuals, the referenced resource stands in as a proxy equivalent for this purpose. This referenced resource may be related to the Binary (e.g. Media, DocumentReference), or may be some non-related Resource purely as a security proxy. E.g. to identify that the binary resource relates to a patient, and access should only be granted to applications that have access to the patient.",
"comment" : "Very often, a server will also know of a resource that references the binary, and can automatically apply the appropriate access rules based on that reference. However, there are some circumstances where this is not appropriate, e.g. the binary is uploaded directly to the server without any linking resource, the binary is referred to from multiple different resources, and/or the binary is content such as an application logo that has less protection than any of the resources that reference it.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Binary.securityContext",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Binary.data",
"path" : "Binary.data",
"short" : "The actual content",
"definition" : "The actual content, base64 encoded.",
"comment" : "If the content type is itself base64 encoding, then this will be base64 encoded twice - what is created by un-base64ing the content must be the specified content type.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Binary.data",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "base64Binary"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "ED.data"
}]
}]
},
"differential" : {
"element" : [{
"id" : "Binary",
"path" : "Binary",
"short" : "Pure binary content defined by a format other than FHIR",
"definition" : "A resource that represents the data of a single raw artifact as digital content accessible in its native format. A Binary resource can contain any content, whether text, image, pdf, zip archive, etc.",
"comment" : "Typically, Binary resources are used for handling content such as: \n\n* CDA Documents (i.e. with XDS) \n* PDF Documents \n* Images (the Media resource is preferred for handling images, but not possible when the content is already binary - e.g. XDS).",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "rim",
"map" : "ED"
}]
},
{
"id" : "Binary.contentType",
"path" : "Binary.contentType",
"short" : "MimeType of the binary content",
"definition" : "MimeType of the binary content represented as a standard MimeType (BCP 13).",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MimeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The mime type of an attachment. Any valid mime type is allowed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|4.0.0"
},
"mapping" : [{
"identity" : "rim",
"map" : "ED.mediaType"
}]
},
{
"id" : "Binary.securityContext",
"path" : "Binary.securityContext",
"short" : "Identifies another resource to use as proxy when enforcing access control",
"definition" : "This element identifies another resource that can be used as a proxy of the security sensitivity to use when deciding and enforcing access control rules for the Binary resource. Given that the Binary resource contains very few elements that can be used to determine the sensitivity of the data and relationships to individuals, the referenced resource stands in as a proxy equivalent for this purpose. This referenced resource may be related to the Binary (e.g. Media, DocumentReference), or may be some non-related Resource purely as a security proxy. E.g. to identify that the binary resource relates to a patient, and access should only be granted to applications that have access to the patient.",
"comment" : "Very often, a server will also know of a resource that references the binary, and can automatically apply the appropriate access rules based on that reference. However, there are some circumstances where this is not appropriate, e.g. the binary is uploaded directly to the server without any linking resource, the binary is referred to from multiple different resources, and/or the binary is content such as an application logo that has less protection than any of the resources that reference it.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Binary.data",
"path" : "Binary.data",
"short" : "The actual content",
"definition" : "The actual content, base64 encoded.",
"comment" : "If the content type is itself base64 encoding, then this will be base64 encoded twice - what is created by un-base64ing the content must be the specified content type.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "base64Binary"
}],
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "ED.data"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProduct",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "BiologicallyDerivedProduct",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints BiologicallyDerivedProduct TU DomainResource A material substance originating from a biological entity
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension \r\n identifier Σ 0..* Identifier External ids for this item
\r\n productCategory 0..1 code organ | tissue | fluid | cells | biologicalAgent
BiologicallyDerivedProductCategory (Required) \r\n productCode 0..1 CodeableConcept What this biologically derived product is \r\n status 0..1 code available | unavailable
BiologicallyDerivedProductStatus (Required) \r\n request 0..* Reference(ServiceRequest) Procedure request
\r\n quantity 0..1 integer The amount of this biologically derived product \r\n parent 0..* Reference(BiologicallyDerivedProduct) BiologicallyDerivedProduct parent
\r\n collection 0..1 BackboneElement How this product was collected \r\n collector 0..1 Reference(Practitioner | PractitionerRole) Individual performing collection \r\n source 0..1 Reference(Patient | Organization) Who is product from \r\n collected[x] 0..1 Time of product collection \r\n collectedDateTime dateTime \r\n collectedPeriod Period \r\n processing 0..* BackboneElement Any processing of the product during collection
\r\n description 0..1 string Description of of processing \r\n procedure 0..1 CodeableConcept Procesing code
Procedure Codes (SNOMED CT) (Example) \r\n additive 0..1 Reference(Substance) Substance added during processing \r\n time[x] 0..1 Time of processing \r\n timeDateTime dateTime \r\n timePeriod Period \r\n manipulation 0..1 BackboneElement Any manipulation of product post-collection \r\n description 0..1 string Description of manipulation \r\n time[x] 0..1 Time of manipulation \r\n timeDateTime dateTime \r\n timePeriod Period \r\n storage 0..* BackboneElement Product storage
\r\n description 0..1 string Description of storage \r\n temperature 0..1 decimal Storage temperature \r\n scale 0..1 code farenheit | celsius | kelvin
BiologicallyDerivedProductStorageScale (Required) \r\n duration 0..1 Period Storage timeperiod \r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Base.Entities"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "oo"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProduct",
"version" : "4.0.0",
"name" : "BiologicallyDerivedProduct",
"status" : "draft",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (Orders and Observations)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/orders/index.cfm"
}]
}],
"description" : "A material substance originating from a biological entity intended to be transplanted or infused\ninto another (possibly the same) biological entity.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "BiologicallyDerivedProduct",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "BiologicallyDerivedProduct",
"path" : "BiologicallyDerivedProduct",
"short" : "A material substance originating from a biological entity",
"definition" : "A material substance originating from a biological entity intended to be transplanted or infused\ninto another (possibly the same) biological entity.",
"comment" : "Substances include, but are not limited to: whole blood, bone marrow, organs, and manipulated blood cells.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "BiologicallyDerivedProduct",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "Material[classCode= Observation[classCode=OBS, moodCode=EVN]"
}]
},
{
"id" : "BiologicallyDerivedProduct.id",
"path" : "BiologicallyDerivedProduct.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "BiologicallyDerivedProduct.meta",
"path" : "BiologicallyDerivedProduct.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "BiologicallyDerivedProduct.implicitRules",
"path" : "BiologicallyDerivedProduct.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "BiologicallyDerivedProduct.language",
"path" : "BiologicallyDerivedProduct.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "BiologicallyDerivedProduct.text",
"path" : "BiologicallyDerivedProduct.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "BiologicallyDerivedProduct.contained",
"path" : "BiologicallyDerivedProduct.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "BiologicallyDerivedProduct.extension",
"path" : "BiologicallyDerivedProduct.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "BiologicallyDerivedProduct.modifierExtension",
"path" : "BiologicallyDerivedProduct.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "BiologicallyDerivedProduct.identifier",
"path" : "BiologicallyDerivedProduct.identifier",
"short" : "External ids for this item",
"definition" : "This records identifiers associated with this biologically derived product instance that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "BiologicallyDerivedProduct.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "IAM-7"
},
{
"identity" : "rim",
"map" : "id"
}]
},
{
"id" : "BiologicallyDerivedProduct.productCategory",
"path" : "BiologicallyDerivedProduct.productCategory",
"short" : "organ | tissue | fluid | cells | biologicalAgent",
"definition" : "Broad category of this product.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BiologicallyDerivedProduct.productCategory",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BiologicallyDerivedProductCategory"
}],
"strength" : "required",
"description" : "Biologically Derived Product Category.",
"valueSet" : "http://hl7.org/fhir/ValueSet/product-category|4.0.0"
}
},
{
"id" : "BiologicallyDerivedProduct.productCode",
"path" : "BiologicallyDerivedProduct.productCode",
"short" : "What this biologically derived product is",
"definition" : "A code that identifies the kind of this biologically derived product (SNOMED Ctcode).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BiologicallyDerivedProduct.productCode",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BiologicallyDerivedProductCode"
}],
"strength" : "example",
"description" : "Biologically Derived Product Code."
}
},
{
"id" : "BiologicallyDerivedProduct.status",
"path" : "BiologicallyDerivedProduct.status",
"short" : "available | unavailable",
"definition" : "Whether the product is currently available.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BiologicallyDerivedProduct.status",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BiologicallyDerivedProductStatus"
}],
"strength" : "required",
"description" : "Biologically Derived Product Status.",
"valueSet" : "http://hl7.org/fhir/ValueSet/product-status|4.0.0"
}
},
{
"id" : "BiologicallyDerivedProduct.request",
"path" : "BiologicallyDerivedProduct.request",
"short" : "Procedure request",
"definition" : "Procedure request to obtain this biologically derived product.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "BiologicallyDerivedProduct.request",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ServiceRequest"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "BiologicallyDerivedProduct.quantity",
"path" : "BiologicallyDerivedProduct.quantity",
"short" : "The amount of this biologically derived product",
"definition" : "Number of discrete units within this product.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BiologicallyDerivedProduct.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "BiologicallyDerivedProduct.parent",
"path" : "BiologicallyDerivedProduct.parent",
"short" : "BiologicallyDerivedProduct parent",
"definition" : "Parent product (if any).",
"comment" : "For products that have multiple collections. For example Peripheral Blood Stem Cells may be collected over several days from a single donor and the donation split into in multiple containers which must be linked to the parent donation.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "BiologicallyDerivedProduct.parent",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProduct"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "BiologicallyDerivedProduct.collection",
"path" : "BiologicallyDerivedProduct.collection",
"short" : "How this product was collected",
"definition" : "How this product was collected.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BiologicallyDerivedProduct.collection",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "BiologicallyDerivedProduct.collection.id",
"path" : "BiologicallyDerivedProduct.collection.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "BiologicallyDerivedProduct.collection.extension",
"path" : "BiologicallyDerivedProduct.collection.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "BiologicallyDerivedProduct.collection.modifierExtension",
"path" : "BiologicallyDerivedProduct.collection.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "BiologicallyDerivedProduct.collection.collector",
"path" : "BiologicallyDerivedProduct.collection.collector",
"short" : "Individual performing collection",
"definition" : "Healthcare professional who is performing the collection.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BiologicallyDerivedProduct.collection.collector",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "BiologicallyDerivedProduct.collection.source",
"path" : "BiologicallyDerivedProduct.collection.source",
"short" : "Who is product from",
"definition" : "The patient or entity, such as a hospital or vendor in the case of a processed/manipulated/manufactured product, providing the product.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BiologicallyDerivedProduct.collection.source",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "BiologicallyDerivedProduct.collection.collected[x]",
"path" : "BiologicallyDerivedProduct.collection.collected[x]",
"short" : "Time of product collection",
"definition" : "Time of product collection.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BiologicallyDerivedProduct.collection.collected[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "BiologicallyDerivedProduct.processing",
"path" : "BiologicallyDerivedProduct.processing",
"short" : "Any processing of the product during collection",
"definition" : "Any processing of the product during collection that does not change the fundamental nature of the product. For example adding anti-coagulants during the collection of Peripheral Blood Stem Cells.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "BiologicallyDerivedProduct.processing",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "BiologicallyDerivedProduct.processing.id",
"path" : "BiologicallyDerivedProduct.processing.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "BiologicallyDerivedProduct.processing.extension",
"path" : "BiologicallyDerivedProduct.processing.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "BiologicallyDerivedProduct.processing.modifierExtension",
"path" : "BiologicallyDerivedProduct.processing.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "BiologicallyDerivedProduct.processing.description",
"path" : "BiologicallyDerivedProduct.processing.description",
"short" : "Description of of processing",
"definition" : "Description of of processing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BiologicallyDerivedProduct.processing.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "BiologicallyDerivedProduct.processing.procedure",
"path" : "BiologicallyDerivedProduct.processing.procedure",
"short" : "Procesing code",
"definition" : "Procesing code.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BiologicallyDerivedProduct.processing.procedure",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BiologicallyDerivedProductProcedure"
}],
"strength" : "example",
"description" : "Biologically Derived Product Procedure.",
"valueSet" : "http://hl7.org/fhir/ValueSet/procedure-code"
}
},
{
"id" : "BiologicallyDerivedProduct.processing.additive",
"path" : "BiologicallyDerivedProduct.processing.additive",
"short" : "Substance added during processing",
"definition" : "Substance added during processing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BiologicallyDerivedProduct.processing.additive",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Substance"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "BiologicallyDerivedProduct.processing.time[x]",
"path" : "BiologicallyDerivedProduct.processing.time[x]",
"short" : "Time of processing",
"definition" : "Time of processing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BiologicallyDerivedProduct.processing.time[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "BiologicallyDerivedProduct.manipulation",
"path" : "BiologicallyDerivedProduct.manipulation",
"short" : "Any manipulation of product post-collection",
"definition" : "Any manipulation of product post-collection that is intended to alter the product. For example a buffy-coat enrichment or CD8 reduction of Peripheral Blood Stem Cells to make it more suitable for infusion.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BiologicallyDerivedProduct.manipulation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "BiologicallyDerivedProduct.manipulation.id",
"path" : "BiologicallyDerivedProduct.manipulation.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "BiologicallyDerivedProduct.manipulation.extension",
"path" : "BiologicallyDerivedProduct.manipulation.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "BiologicallyDerivedProduct.manipulation.modifierExtension",
"path" : "BiologicallyDerivedProduct.manipulation.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "BiologicallyDerivedProduct.manipulation.description",
"path" : "BiologicallyDerivedProduct.manipulation.description",
"short" : "Description of manipulation",
"definition" : "Description of manipulation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BiologicallyDerivedProduct.manipulation.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "BiologicallyDerivedProduct.manipulation.time[x]",
"path" : "BiologicallyDerivedProduct.manipulation.time[x]",
"short" : "Time of manipulation",
"definition" : "Time of manipulation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BiologicallyDerivedProduct.manipulation.time[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "BiologicallyDerivedProduct.storage",
"path" : "BiologicallyDerivedProduct.storage",
"short" : "Product storage",
"definition" : "Product storage.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "BiologicallyDerivedProduct.storage",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "BiologicallyDerivedProduct.storage.id",
"path" : "BiologicallyDerivedProduct.storage.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "BiologicallyDerivedProduct.storage.extension",
"path" : "BiologicallyDerivedProduct.storage.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "BiologicallyDerivedProduct.storage.modifierExtension",
"path" : "BiologicallyDerivedProduct.storage.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "BiologicallyDerivedProduct.storage.description",
"path" : "BiologicallyDerivedProduct.storage.description",
"short" : "Description of storage",
"definition" : "Description of storage.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BiologicallyDerivedProduct.storage.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "BiologicallyDerivedProduct.storage.temperature",
"path" : "BiologicallyDerivedProduct.storage.temperature",
"short" : "Storage temperature",
"definition" : "Storage temperature.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BiologicallyDerivedProduct.storage.temperature",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "BiologicallyDerivedProduct.storage.scale",
"path" : "BiologicallyDerivedProduct.storage.scale",
"short" : "farenheit | celsius | kelvin",
"definition" : "Temperature scale used.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BiologicallyDerivedProduct.storage.scale",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BiologicallyDerivedProductStorageScale"
}],
"strength" : "required",
"description" : "BiologicallyDerived Product Storage Scale.",
"valueSet" : "http://hl7.org/fhir/ValueSet/product-storage-scale|4.0.0"
}
},
{
"id" : "BiologicallyDerivedProduct.storage.duration",
"path" : "BiologicallyDerivedProduct.storage.duration",
"short" : "Storage timeperiod",
"definition" : "Storage timeperiod.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BiologicallyDerivedProduct.storage.duration",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "BiologicallyDerivedProduct",
"path" : "BiologicallyDerivedProduct",
"short" : "A material substance originating from a biological entity",
"definition" : "A material substance originating from a biological entity intended to be transplanted or infused\ninto another (possibly the same) biological entity.",
"comment" : "Substances include, but are not limited to: whole blood, bone marrow, organs, and manipulated blood cells.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "rim",
"map" : "Material[classCode= Observation[classCode=OBS, moodCode=EVN]"
}]
},
{
"id" : "BiologicallyDerivedProduct.identifier",
"path" : "BiologicallyDerivedProduct.identifier",
"short" : "External ids for this item",
"definition" : "This records identifiers associated with this biologically derived product instance that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "IAM-7"
},
{
"identity" : "rim",
"map" : "id"
}]
},
{
"id" : "BiologicallyDerivedProduct.productCategory",
"path" : "BiologicallyDerivedProduct.productCategory",
"short" : "organ | tissue | fluid | cells | biologicalAgent",
"definition" : "Broad category of this product.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BiologicallyDerivedProductCategory"
}],
"strength" : "required",
"description" : "Biologically Derived Product Category.",
"valueSet" : "http://hl7.org/fhir/ValueSet/product-category|4.0.0"
}
},
{
"id" : "BiologicallyDerivedProduct.productCode",
"path" : "BiologicallyDerivedProduct.productCode",
"short" : "What this biologically derived product is",
"definition" : "A code that identifies the kind of this biologically derived product (SNOMED Ctcode).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BiologicallyDerivedProductCode"
}],
"strength" : "example",
"description" : "Biologically Derived Product Code."
}
},
{
"id" : "BiologicallyDerivedProduct.status",
"path" : "BiologicallyDerivedProduct.status",
"short" : "available | unavailable",
"definition" : "Whether the product is currently available.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BiologicallyDerivedProductStatus"
}],
"strength" : "required",
"description" : "Biologically Derived Product Status.",
"valueSet" : "http://hl7.org/fhir/ValueSet/product-status|4.0.0"
}
},
{
"id" : "BiologicallyDerivedProduct.request",
"path" : "BiologicallyDerivedProduct.request",
"short" : "Procedure request",
"definition" : "Procedure request to obtain this biologically derived product.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ServiceRequest"]
}]
},
{
"id" : "BiologicallyDerivedProduct.quantity",
"path" : "BiologicallyDerivedProduct.quantity",
"short" : "The amount of this biologically derived product",
"definition" : "Number of discrete units within this product.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}]
},
{
"id" : "BiologicallyDerivedProduct.parent",
"path" : "BiologicallyDerivedProduct.parent",
"short" : "BiologicallyDerivedProduct parent",
"definition" : "Parent product (if any).",
"comment" : "For products that have multiple collections. For example Peripheral Blood Stem Cells may be collected over several days from a single donor and the donation split into in multiple containers which must be linked to the parent donation.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProduct"]
}]
},
{
"id" : "BiologicallyDerivedProduct.collection",
"path" : "BiologicallyDerivedProduct.collection",
"short" : "How this product was collected",
"definition" : "How this product was collected.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "BiologicallyDerivedProduct.collection.collector",
"path" : "BiologicallyDerivedProduct.collection.collector",
"short" : "Individual performing collection",
"definition" : "Healthcare professional who is performing the collection.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}]
},
{
"id" : "BiologicallyDerivedProduct.collection.source",
"path" : "BiologicallyDerivedProduct.collection.source",
"short" : "Who is product from",
"definition" : "The patient or entity, such as a hospital or vendor in the case of a processed/manipulated/manufactured product, providing the product.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}]
},
{
"id" : "BiologicallyDerivedProduct.collection.collected[x]",
"path" : "BiologicallyDerivedProduct.collection.collected[x]",
"short" : "Time of product collection",
"definition" : "Time of product collection.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
}]
},
{
"id" : "BiologicallyDerivedProduct.processing",
"path" : "BiologicallyDerivedProduct.processing",
"short" : "Any processing of the product during collection",
"definition" : "Any processing of the product during collection that does not change the fundamental nature of the product. For example adding anti-coagulants during the collection of Peripheral Blood Stem Cells.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "BiologicallyDerivedProduct.processing.description",
"path" : "BiologicallyDerivedProduct.processing.description",
"short" : "Description of of processing",
"definition" : "Description of of processing.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "BiologicallyDerivedProduct.processing.procedure",
"path" : "BiologicallyDerivedProduct.processing.procedure",
"short" : "Procesing code",
"definition" : "Procesing code.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BiologicallyDerivedProductProcedure"
}],
"strength" : "example",
"description" : "Biologically Derived Product Procedure.",
"valueSet" : "http://hl7.org/fhir/ValueSet/procedure-code"
}
},
{
"id" : "BiologicallyDerivedProduct.processing.additive",
"path" : "BiologicallyDerivedProduct.processing.additive",
"short" : "Substance added during processing",
"definition" : "Substance added during processing.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Substance"]
}]
},
{
"id" : "BiologicallyDerivedProduct.processing.time[x]",
"path" : "BiologicallyDerivedProduct.processing.time[x]",
"short" : "Time of processing",
"definition" : "Time of processing.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
}]
},
{
"id" : "BiologicallyDerivedProduct.manipulation",
"path" : "BiologicallyDerivedProduct.manipulation",
"short" : "Any manipulation of product post-collection",
"definition" : "Any manipulation of product post-collection that is intended to alter the product. For example a buffy-coat enrichment or CD8 reduction of Peripheral Blood Stem Cells to make it more suitable for infusion.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "BiologicallyDerivedProduct.manipulation.description",
"path" : "BiologicallyDerivedProduct.manipulation.description",
"short" : "Description of manipulation",
"definition" : "Description of manipulation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "BiologicallyDerivedProduct.manipulation.time[x]",
"path" : "BiologicallyDerivedProduct.manipulation.time[x]",
"short" : "Time of manipulation",
"definition" : "Time of manipulation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
}]
},
{
"id" : "BiologicallyDerivedProduct.storage",
"path" : "BiologicallyDerivedProduct.storage",
"short" : "Product storage",
"definition" : "Product storage.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "BiologicallyDerivedProduct.storage.description",
"path" : "BiologicallyDerivedProduct.storage.description",
"short" : "Description of storage",
"definition" : "Description of storage.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "BiologicallyDerivedProduct.storage.temperature",
"path" : "BiologicallyDerivedProduct.storage.temperature",
"short" : "Storage temperature",
"definition" : "Storage temperature.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}]
},
{
"id" : "BiologicallyDerivedProduct.storage.scale",
"path" : "BiologicallyDerivedProduct.storage.scale",
"short" : "farenheit | celsius | kelvin",
"definition" : "Temperature scale used.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BiologicallyDerivedProductStorageScale"
}],
"strength" : "required",
"description" : "BiologicallyDerived Product Storage Scale.",
"valueSet" : "http://hl7.org/fhir/ValueSet/product-storage-scale|4.0.0"
}
},
{
"id" : "BiologicallyDerivedProduct.storage.duration",
"path" : "BiologicallyDerivedProduct.storage.duration",
"short" : "Storage timeperiod",
"definition" : "Storage timeperiod.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/BodyStructure",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "BodyStructure",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints BodyStructure TU DomainResource Specific and identified anatomical structure
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension \r\n identifier Σ 0..* Identifier Bodystructure identifier
\r\n active ?!Σ 0..1 boolean Whether this record is in active use \r\n morphology Σ 0..1 CodeableConcept Kind of Structure
SNOMED CT Morphologic Abnormalities (Example) \r\n location Σ 0..1 CodeableConcept Body site
SNOMED CT Body Structures (Example) \r\n locationQualifier 0..* CodeableConcept Body site modifier
Bodystructure Location Qualifier (Example)
\r\n description Σ 0..1 string Text description \r\n image 0..* Attachment Attached images
\r\n patient Σ 1..1 Reference(Patient) Who this is about \r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Diagnostics"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "oo"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/BodyStructure",
"version" : "4.0.0",
"name" : "BodyStructure",
"status" : "draft",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (Orders and Observations)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/orders/index.cfm"
}]
}],
"description" : "Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "openehr",
"uri" : "http://openehr.org",
"name" : "Open EHR Archetype Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "BodyStructure",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "BodyStructure",
"path" : "BodyStructure",
"short" : "Specific and identified anatomical structure",
"definition" : "Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.",
"alias" : ["anatomical location"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BodyStructure",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "ActSIte"
},
{
"identity" : "openehr",
"map" : "Archetype ID openEHR-EHR-CLUSTER.anatomical_location.v1 Concept name Anatomical Location Concept description Record details about an anatomical location. Keywords location, site, anatomical Copyright © openEHR Foundation Purpose To record details about anatomical location. Misuse Not for specifiying unilateral/bilateral occurrence - this is related to an evaluation which perhaps includes multiple locations. Author Author name: Heather Leslie Organization: Ocean Informatics Email: [email protected] Date of Origination: 2008-11-10 Translator Norwegian Bokmål: Lars Bitsch-Larsen, Haukeland University Hospital of Bergen, Norway, MD, DEAA, MBA, spec in anesthesia, spec in tropical medicine. Arabic (Syria): Mona Saleh Other contributors Heather Leslie, Ocean Informatics, Australia (Editor) Ian McNicoll, freshEHR Clinical Informatics, United Kingdom (Editor) Dunmail Hodkinson, Black Pear Software Ltd, UK References Use cases: - 5LICS, midclavicular line - L forearm, 2cm anterior to the cubital fossa - Right iliac fossa - 5 cm below L tibial tuberosity - 2 cm medial to R nipple - 4 cm below R costal margin in midclavicular line - R femur - midline nose - medial aspect of R great toe nail."
}]
},
{
"id" : "BodyStructure.id",
"path" : "BodyStructure.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "BodyStructure.meta",
"path" : "BodyStructure.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "BodyStructure.implicitRules",
"path" : "BodyStructure.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "BodyStructure.language",
"path" : "BodyStructure.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "BodyStructure.text",
"path" : "BodyStructure.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "BodyStructure.contained",
"path" : "BodyStructure.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "BodyStructure.extension",
"path" : "BodyStructure.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "BodyStructure.modifierExtension",
"path" : "BodyStructure.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "BodyStructure.identifier",
"path" : "BodyStructure.identifier",
"short" : "Bodystructure identifier",
"definition" : "Identifier for this instance of the anatomical structure.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "BodyStructure.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
},
{
"identity" : "openehr",
"map" : "Specific location Cluster Optional (0..1) Cardinality: Mandatory, repeating, unordered (1..*)"
}]
},
{
"id" : "BodyStructure.active",
"path" : "BodyStructure.active",
"short" : "Whether this record is in active use",
"definition" : "Whether this body site is in active use.",
"comment" : "This element is labeled as a modifier because it may be used to mark that the resource was created in error.",
"requirements" : "Need to be able to mark a body site entry as not to be used because it was created in error.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BodyStructure.active",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "This resource is generally assumed to be active if no value is provided for the active element",
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : "statusCode"
}]
},
{
"id" : "BodyStructure.morphology",
"path" : "BodyStructure.morphology",
"short" : "Kind of Structure",
"definition" : "The kind of structure being represented by the body structure at `BodyStructure.location`. This can define both normal and abnormal morphologies.",
"comment" : "The minimum cardinality of 0 supports the use case of specifying a location without defining a morphology.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BodyStructure.morphology",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BodyStructureCode"
}],
"strength" : "example",
"description" : "Codes describing anatomic morphology.",
"valueSet" : "http://hl7.org/fhir/ValueSet/bodystructure-code"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "SPM-4/SPM-5"
}]
},
{
"id" : "BodyStructure.location",
"path" : "BodyStructure.location",
"short" : "Body site",
"definition" : "The anatomical location or region of the specimen, lesion, or body structure.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BodyStructure.location",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BodySite"
}],
"strength" : "example",
"description" : "Codes describing anatomical locations. May include laterality.",
"valueSet" : "http://hl7.org/fhir/ValueSet/body-site"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "OBX-20/SPM-8/SPM-10"
},
{
"identity" : "rim",
"map" : ".targetSiteCode"
},
{
"identity" : "openehr",
"map" : "Name of location"
}]
},
{
"id" : "BodyStructure.locationQualifier",
"path" : "BodyStructure.locationQualifier",
"short" : "Body site modifier",
"definition" : "Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "BodyStructure.locationQualifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BodyStructureQualifier"
}],
"strength" : "example",
"description" : "Concepts modifying the anatomic location.",
"valueSet" : "http://hl7.org/fhir/ValueSet/bodystructure-relative-location"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "No distinct element defined in V2.x. The IHE Radiology Technical Framework directs the use of OBR-15-specimen source to contain laterality for imaging studies./SPM-9"
},
{
"identity" : "rim",
"map" : ".targetSiteCode"
},
{
"identity" : "openehr",
"map" : "Combines Side, Numerical identifier, Anatomical plane,and Aspect"
}]
},
{
"id" : "BodyStructure.description",
"path" : "BodyStructure.description",
"short" : "Text description",
"definition" : "A summary, characterization or explanation of the body structure.",
"comment" : "This description could include any visual markings used to orientate the viewer e.g. external reference points, special sutures, ink markings.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BodyStructure.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "NTE"
},
{
"identity" : "rim",
"map" : ".text"
},
{
"identity" : "openehr",
"map" : "Description of anatomical location/Visual markings/orientation"
}]
},
{
"id" : "BodyStructure.image",
"path" : "BodyStructure.image",
"short" : "Attached images",
"definition" : "Image or images used to identify a location.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "BodyStructure.image",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Attachment"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "OBX"
},
{
"identity" : "rim",
"map" : "outboundRelationship[typeCode=COMP].target"
},
{
"identity" : "openehr",
"map" : "Image"
}]
},
{
"id" : "BodyStructure.patient",
"path" : "BodyStructure.patient",
"short" : "Who this is about",
"definition" : "The person to which the body site belongs.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "BodyStructure.patient",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PID-3"
},
{
"identity" : "rim",
"map" : ".scoper or .scoper.playsRole"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
}]
},
"differential" : {
"element" : [{
"id" : "BodyStructure",
"path" : "BodyStructure",
"short" : "Specific and identified anatomical structure",
"definition" : "Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.",
"alias" : ["anatomical location"],
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "rim",
"map" : "ActSIte"
},
{
"identity" : "openehr",
"map" : "Archetype ID openEHR-EHR-CLUSTER.anatomical_location.v1 Concept name Anatomical Location Concept description Record details about an anatomical location. Keywords location, site, anatomical Copyright © openEHR Foundation Purpose To record details about anatomical location. Misuse Not for specifiying unilateral/bilateral occurrence - this is related to an evaluation which perhaps includes multiple locations. Author Author name: Heather Leslie Organization: Ocean Informatics Email: [email protected] Date of Origination: 2008-11-10 Translator Norwegian Bokmål: Lars Bitsch-Larsen, Haukeland University Hospital of Bergen, Norway, MD, DEAA, MBA, spec in anesthesia, spec in tropical medicine. Arabic (Syria): Mona Saleh Other contributors Heather Leslie, Ocean Informatics, Australia (Editor) Ian McNicoll, freshEHR Clinical Informatics, United Kingdom (Editor) Dunmail Hodkinson, Black Pear Software Ltd, UK References Use cases: - 5LICS, midclavicular line - L forearm, 2cm anterior to the cubital fossa - Right iliac fossa - 5 cm below L tibial tuberosity - 2 cm medial to R nipple - 4 cm below R costal margin in midclavicular line - R femur - midline nose - medial aspect of R great toe nail."
}]
},
{
"id" : "BodyStructure.identifier",
"path" : "BodyStructure.identifier",
"short" : "Bodystructure identifier",
"definition" : "Identifier for this instance of the anatomical structure.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
},
{
"identity" : "openehr",
"map" : "Specific location Cluster Optional (0..1) Cardinality: Mandatory, repeating, unordered (1..*)"
}]
},
{
"id" : "BodyStructure.active",
"path" : "BodyStructure.active",
"short" : "Whether this record is in active use",
"definition" : "Whether this body site is in active use.",
"comment" : "This element is labeled as a modifier because it may be used to mark that the resource was created in error.",
"requirements" : "Need to be able to mark a body site entry as not to be used because it was created in error.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "This resource is generally assumed to be active if no value is provided for the active element",
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : "statusCode"
}]
},
{
"id" : "BodyStructure.morphology",
"path" : "BodyStructure.morphology",
"short" : "Kind of Structure",
"definition" : "The kind of structure being represented by the body structure at `BodyStructure.location`. This can define both normal and abnormal morphologies.",
"comment" : "The minimum cardinality of 0 supports the use case of specifying a location without defining a morphology.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BodyStructureCode"
}],
"strength" : "example",
"description" : "Codes describing anatomic morphology.",
"valueSet" : "http://hl7.org/fhir/ValueSet/bodystructure-code"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "SPM-4/SPM-5"
}]
},
{
"id" : "BodyStructure.location",
"path" : "BodyStructure.location",
"short" : "Body site",
"definition" : "The anatomical location or region of the specimen, lesion, or body structure.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BodySite"
}],
"strength" : "example",
"description" : "Codes describing anatomical locations. May include laterality.",
"valueSet" : "http://hl7.org/fhir/ValueSet/body-site"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "OBX-20/SPM-8/SPM-10"
},
{
"identity" : "rim",
"map" : ".targetSiteCode"
},
{
"identity" : "openehr",
"map" : "Name of location"
}]
},
{
"id" : "BodyStructure.locationQualifier",
"path" : "BodyStructure.locationQualifier",
"short" : "Body site modifier",
"definition" : "Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BodyStructureQualifier"
}],
"strength" : "example",
"description" : "Concepts modifying the anatomic location.",
"valueSet" : "http://hl7.org/fhir/ValueSet/bodystructure-relative-location"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "No distinct element defined in V2.x. The IHE Radiology Technical Framework directs the use of OBR-15-specimen source to contain laterality for imaging studies./SPM-9"
},
{
"identity" : "rim",
"map" : ".targetSiteCode"
},
{
"identity" : "openehr",
"map" : "Combines Side, Numerical identifier, Anatomical plane,and Aspect"
}]
},
{
"id" : "BodyStructure.description",
"path" : "BodyStructure.description",
"short" : "Text description",
"definition" : "A summary, characterization or explanation of the body structure.",
"comment" : "This description could include any visual markings used to orientate the viewer e.g. external reference points, special sutures, ink markings.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "NTE"
},
{
"identity" : "rim",
"map" : ".text"
},
{
"identity" : "openehr",
"map" : "Description of anatomical location/Visual markings/orientation"
}]
},
{
"id" : "BodyStructure.image",
"path" : "BodyStructure.image",
"short" : "Attached images",
"definition" : "Image or images used to identify a location.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Attachment"
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "OBX"
},
{
"identity" : "rim",
"map" : "outboundRelationship[typeCode=COMP].target"
},
{
"identity" : "openehr",
"map" : "Image"
}]
},
{
"id" : "BodyStructure.patient",
"path" : "BodyStructure.patient",
"short" : "Who this is about",
"definition" : "The person to which the body site belongs.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PID-3"
},
{
"identity" : "rim",
"map" : ".scoper or .scoper.playsRole"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/Bundle",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "Bundle",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints Bundle ΣIN Resource Contains a collection of resources
+ Rule: total only when a search or history
+ Rule: entry.search only when a search
+ Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited
+ Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
+ Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
+ Rule: A document must have an identifier with a system and a value
+ Rule: A document must have a date
+ Rule: A document must have a Composition as the first resource
+ Rule: A message must have a MessageHeader as the first resource
Elements defined in Ancestors: id, meta, implicitRules, language \r\n identifier Σ 0..1 Identifier Persistent identifier for the bundle \r\n type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
BundleType (Required) \r\n timestamp Σ 0..1 instant When the bundle was assembled \r\n total ΣI 0..1 unsignedInt If search, the total number of matches \r\n link Σ 0..* BackboneElement Links related to this Bundle
\r\n relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 \r\n url Σ 1..1 uri Reference details for the link \r\n entry ΣI 0..* BackboneElement Entry in the bundle - will have a resource or information
+ Rule: must be a resource unless there's a request or response
+ Rule: fullUrl cannot be a version specific reference
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type \r\n link Σ 0..* see link Links related to this entry
\r\n fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID) \r\n resource Σ 0..1 Resource A resource in the bundle \r\n search ΣI 0..1 BackboneElement Search related information \r\n mode Σ 0..1 code match | include | outcome - why this is in the result set
SearchEntryMode (Required) \r\n score Σ 0..1 decimal Search ranking (between 0 and 1) \r\n request ΣI 0..1 BackboneElement Additional execution information (transaction/batch/history) \r\n method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
HTTPVerb (Required) \r\n url Σ 1..1 uri URL for HTTP equivalent of this entry \r\n ifNoneMatch Σ 0..1 string For managing cache currency \r\n ifModifiedSince Σ 0..1 instant For managing cache currency \r\n ifMatch Σ 0..1 string For managing update contention \r\n ifNoneExist Σ 0..1 string For conditional creates \r\n response ΣI 0..1 BackboneElement Results of execution (transaction/batch/history) \r\n status Σ 1..1 string Status response code (text optional) \r\n location Σ 0..1 uri The location (if the operation returns a location) \r\n etag Σ 0..1 string The Etag for the resource (if relevant) \r\n lastModified Σ 0..1 instant Server's date time modified \r\n outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction) \r\n signature ΣTU 0..1 Signature Digital Signature \r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Other"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "not-classified"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Bundle",
"version" : "4.0.0",
"name" : "Bundle",
"status" : "active",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}]
}],
"description" : "A container for a collection of resources.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "cda",
"uri" : "http://hl7.org/v3/cda",
"name" : "CDA (R2)"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Bundle",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Resource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Bundle",
"path" : "Bundle",
"short" : "Contains a collection of resources",
"definition" : "A container for a collection of resources.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Bundle",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "bdl-7",
"severity" : "error",
"human" : "FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)",
"expression" : "(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()",
"xpath" : "(f:type/@value = 'history') or (count(for $entry in f:entry[f:resource] return $entry[count(parent::f:Bundle/f:entry[f:fullUrl/@value=$entry/f:fullUrl/@value and ((not(f:resource/*/f:meta/f:versionId/@value) and not($entry/f:resource/*/f:meta/f:versionId/@value)) or f:resource/*/f:meta/f:versionId/@value=$entry/f:resource/*/f:meta/f:versionId/@value)])!=1])=0)"
},
{
"key" : "bdl-9",
"severity" : "error",
"human" : "A document must have an identifier with a system and a value",
"expression" : "type = 'document' implies (identifier.system.exists() and identifier.value.exists())",
"xpath" : "not(f:type/@value = 'document') or exists(f:identifier/f:system) or exists(f:identifier/f:value)"
},
{
"key" : "bdl-3",
"severity" : "error",
"human" : "entry.request mandatory for batch/transaction/history, otherwise prohibited",
"expression" : "entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))",
"xpath" : "not(f:entry/f:request) or (f:type/@value = 'batch') or (f:type/@value = 'transaction') or (f:type/@value = 'history')"
},
{
"key" : "bdl-4",
"severity" : "error",
"human" : "entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited",
"expression" : "entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))",
"xpath" : "not(f:entry/f:response) or (f:type/@value = 'batch-response') or (f:type/@value = 'transaction-response') or (f:type/@value = 'history')"
},
{
"key" : "bdl-12",
"severity" : "error",
"human" : "A message must have a MessageHeader as the first resource",
"expression" : "type = 'message' implies entry.first().resource.is(MessageHeader)",
"xpath" : "not(f:type/@value='message') or f:entry[1]/f:resource/f:MessageHeader"
},
{
"key" : "bdl-1",
"severity" : "error",
"human" : "total only when a search or history",
"expression" : "total.empty() or (type = 'searchset') or (type = 'history')",
"xpath" : "not(f:total) or (f:type/@value = 'searchset') or (f:type/@value = 'history')"
},
{
"key" : "bdl-2",
"severity" : "error",
"human" : "entry.search only when a search",
"expression" : "entry.search.empty() or (type = 'searchset')",
"xpath" : "not(f:entry/f:search) or (f:type/@value = 'searchset')"
},
{
"key" : "bdl-11",
"severity" : "error",
"human" : "A document must have a Composition as the first resource",
"expression" : "type = 'document' implies entry.first().resource.is(Composition)",
"xpath" : "not(f:type/@value='document') or f:entry[1]/f:resource/f:Composition"
},
{
"key" : "bdl-10",
"severity" : "error",
"human" : "A document must have a date",
"expression" : "type = 'document' implies (meta.lastUpdated.hasValue())",
"xpath" : "not(f:type/@value = 'document') or exists(f:meta/f:lastUpdated/f:value)"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "N/A"
},
{
"identity" : "cda",
"map" : "ClinicalDocument, if bundle.type = document"
}]
},
{
"id" : "Bundle.id",
"path" : "Bundle.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Bundle.meta",
"path" : "Bundle.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Bundle.implicitRules",
"path" : "Bundle.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Bundle.language",
"path" : "Bundle.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Bundle.identifier",
"path" : "Bundle.identifier",
"short" : "Persistent identifier for the bundle",
"definition" : "A persistent identifier for the bundle that won't change as a bundle is copied from server to server.",
"comment" : "Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Bundle.identifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "cda",
"map" : "ClinicalDocument.id"
}]
},
{
"id" : "Bundle.type",
"path" : "Bundle.type",
"short" : "document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection",
"definition" : "Indicates the purpose of this bundle - how it is intended to be used.",
"comment" : "It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Bundle.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BundleType"
}],
"strength" : "required",
"description" : "Indicates the purpose of a bundle - how it is intended to be used.",
"valueSet" : "http://hl7.org/fhir/ValueSet/bundle-type|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Bundle.timestamp",
"path" : "Bundle.timestamp",
"short" : "When the bundle was assembled",
"definition" : "The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.",
"comment" : "For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated. \n\nUsage:\n\n* document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time\n* message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message\n* history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates\n* searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query\n* transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning\n\nThe timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Bundle.timestamp",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "instant"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.init"
},
{
"identity" : "cda",
"map" : "ClinicalDocument.effectiveTime"
}]
},
{
"id" : "Bundle.total",
"path" : "Bundle.total",
"short" : "If search, the total number of matches",
"definition" : "If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.",
"comment" : "Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Bundle.total",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "unsignedInt"
}],
"condition" : ["bdl-1"],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Bundle.link",
"path" : "Bundle.link",
"short" : "Links related to this Bundle",
"definition" : "A series of links that provide context to this bundle.",
"comment" : "Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)). \n\nBundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.\n\nThis specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Bundle.link",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Bundle.link.id",
"path" : "Bundle.link.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Bundle.link.extension",
"path" : "Bundle.link.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Bundle.link.modifierExtension",
"path" : "Bundle.link.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Bundle.link.relation",
"path" : "Bundle.link.relation",
"short" : "See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1",
"definition" : "A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Bundle.link.relation",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Bundle.link.url",
"path" : "Bundle.link.url",
"short" : "Reference details for the link",
"definition" : "The reference details for the link.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Bundle.link.url",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Bundle.entry",
"path" : "Bundle.entry",
"short" : "Entry in the bundle - will have a resource or information",
"definition" : "An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Bundle.entry",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"orderMeaning" : "For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "bdl-8",
"severity" : "error",
"human" : "fullUrl cannot be a version specific reference",
"expression" : "fullUrl.contains('/_history/').not()",
"xpath" : "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))"
},
{
"key" : "bdl-5",
"severity" : "error",
"human" : "must be a resource unless there's a request or response",
"expression" : "resource.exists() or request.exists() or response.exists()",
"xpath" : "exists(f:resource) or exists(f:request) or exists(f:response)"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Bundle.entry.id",
"path" : "Bundle.entry.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Bundle.entry.extension",
"path" : "Bundle.entry.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Bundle.entry.modifierExtension",
"path" : "Bundle.entry.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Bundle.entry.link",
"path" : "Bundle.entry.link",
"short" : "Links related to this entry",
"definition" : "A series of links that provide context to this entry.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Bundle.entry.link",
"min" : 0,
"max" : "*"
},
"contentReference" : "#Bundle.link",
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Bundle.entry.fullUrl",
"path" : "Bundle.entry.fullUrl",
"short" : "URI for resource (Absolute URL server address or URI for UUID/OID)",
"definition" : "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.",
"comment" : "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Bundle.entry.fullUrl",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Bundle.entry.resource",
"path" : "Bundle.entry.resource",
"short" : "A resource in the bundle",
"definition" : "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Bundle.entry.resource",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Bundle.entry.search",
"path" : "Bundle.entry.search",
"short" : "Search related information",
"definition" : "Information about the search process that lead to the creation of this entry.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Bundle.entry.search",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["bdl-2"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Bundle.entry.search.id",
"path" : "Bundle.entry.search.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Bundle.entry.search.extension",
"path" : "Bundle.entry.search.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Bundle.entry.search.modifierExtension",
"path" : "Bundle.entry.search.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Bundle.entry.search.mode",
"path" : "Bundle.entry.search.mode",
"short" : "match | include | outcome - why this is in the result set",
"definition" : "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.",
"comment" : "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Bundle.entry.search.mode",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SearchEntryMode"
}],
"strength" : "required",
"description" : "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.",
"valueSet" : "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.0"
}
},
{
"id" : "Bundle.entry.search.score",
"path" : "Bundle.entry.search.score",
"short" : "Search ranking (between 0 and 1)",
"definition" : "When searching, the server's search ranking score for the entry.",
"comment" : "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Bundle.entry.search.score",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Bundle.entry.request",
"path" : "Bundle.entry.request",
"short" : "Additional execution information (transaction/batch/history)",
"definition" : "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Bundle.entry.request",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["bdl-3"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Bundle.entry.request.id",
"path" : "Bundle.entry.request.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Bundle.entry.request.extension",
"path" : "Bundle.entry.request.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Bundle.entry.request.modifierExtension",
"path" : "Bundle.entry.request.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Bundle.entry.request.method",
"path" : "Bundle.entry.request.method",
"short" : "GET | HEAD | POST | PUT | DELETE | PATCH",
"definition" : "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Bundle.entry.request.method",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "HTTPVerb"
}],
"strength" : "required",
"description" : "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.",
"valueSet" : "http://hl7.org/fhir/ValueSet/http-verb|4.0.0"
}
},
{
"id" : "Bundle.entry.request.url",
"path" : "Bundle.entry.request.url",
"short" : "URL for HTTP equivalent of this entry",
"definition" : "The URL for this entry, relative to the root (the address to which the request is posted).",
"comment" : "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Bundle.entry.request.url",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Bundle.entry.request.ifNoneMatch",
"path" : "Bundle.entry.request.ifNoneMatch",
"short" : "For managing cache currency",
"definition" : "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Bundle.entry.request.ifNoneMatch",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Bundle.entry.request.ifModifiedSince",
"path" : "Bundle.entry.request.ifModifiedSince",
"short" : "For managing cache currency",
"definition" : "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Bundle.entry.request.ifModifiedSince",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "instant"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Bundle.entry.request.ifMatch",
"path" : "Bundle.entry.request.ifMatch",
"short" : "For managing update contention",
"definition" : "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Bundle.entry.request.ifMatch",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Bundle.entry.request.ifNoneExist",
"path" : "Bundle.entry.request.ifNoneExist",
"short" : "For conditional creates",
"definition" : "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Bundle.entry.request.ifNoneExist",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Bundle.entry.response",
"path" : "Bundle.entry.response",
"short" : "Results of execution (transaction/batch/history)",
"definition" : "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Bundle.entry.response",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["bdl-4"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Bundle.entry.response.id",
"path" : "Bundle.entry.response.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Bundle.entry.response.extension",
"path" : "Bundle.entry.response.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Bundle.entry.response.modifierExtension",
"path" : "Bundle.entry.response.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Bundle.entry.response.status",
"path" : "Bundle.entry.response.status",
"short" : "Status response code (text optional)",
"definition" : "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Bundle.entry.response.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Bundle.entry.response.location",
"path" : "Bundle.entry.response.location",
"short" : "The location (if the operation returns a location)",
"definition" : "The location header created by processing this operation, populated if the operation returns a location.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Bundle.entry.response.location",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Bundle.entry.response.etag",
"path" : "Bundle.entry.response.etag",
"short" : "The Etag for the resource (if relevant)",
"definition" : "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).",
"comment" : "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Bundle.entry.response.etag",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Bundle.entry.response.lastModified",
"path" : "Bundle.entry.response.lastModified",
"short" : "Server's date time modified",
"definition" : "The date/time that the resource was modified on the server.",
"comment" : "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Bundle.entry.response.lastModified",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "instant"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Bundle.entry.response.outcome",
"path" : "Bundle.entry.response.outcome",
"short" : "OperationOutcome with hints and warnings (for batch/transaction)",
"definition" : "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.",
"comment" : "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Bundle.entry.response.outcome",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Bundle.signature",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "Bundle.signature",
"short" : "Digital Signature",
"definition" : "Digital Signature - base64 encoded. XML-DSig or a JWT.",
"comment" : "The signature could be created by the \"author\" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.",
"requirements" : "A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Bundle.signature",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Signature"
}],
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "Bundle",
"path" : "Bundle",
"short" : "Contains a collection of resources",
"definition" : "A container for a collection of resources.",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "bdl-7",
"severity" : "error",
"human" : "FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)",
"expression" : "(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()",
"xpath" : "(f:type/@value = 'history') or (count(for $entry in f:entry[f:resource] return $entry[count(parent::f:Bundle/f:entry[f:fullUrl/@value=$entry/f:fullUrl/@value and ((not(f:resource/*/f:meta/f:versionId/@value) and not($entry/f:resource/*/f:meta/f:versionId/@value)) or f:resource/*/f:meta/f:versionId/@value=$entry/f:resource/*/f:meta/f:versionId/@value)])!=1])=0)"
},
{
"key" : "bdl-9",
"severity" : "error",
"human" : "A document must have an identifier with a system and a value",
"expression" : "type = 'document' implies (identifier.system.exists() and identifier.value.exists())",
"xpath" : "not(f:type/@value = 'document') or exists(f:identifier/f:system) or exists(f:identifier/f:value)"
},
{
"key" : "bdl-3",
"severity" : "error",
"human" : "entry.request mandatory for batch/transaction/history, otherwise prohibited",
"expression" : "entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))",
"xpath" : "not(f:entry/f:request) or (f:type/@value = 'batch') or (f:type/@value = 'transaction') or (f:type/@value = 'history')"
},
{
"key" : "bdl-4",
"severity" : "error",
"human" : "entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited",
"expression" : "entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))",
"xpath" : "not(f:entry/f:response) or (f:type/@value = 'batch-response') or (f:type/@value = 'transaction-response') or (f:type/@value = 'history')"
},
{
"key" : "bdl-12",
"severity" : "error",
"human" : "A message must have a MessageHeader as the first resource",
"expression" : "type = 'message' implies entry.first().resource.is(MessageHeader)",
"xpath" : "not(f:type/@value='message') or f:entry[1]/f:resource/f:MessageHeader"
},
{
"key" : "bdl-1",
"severity" : "error",
"human" : "total only when a search or history",
"expression" : "total.empty() or (type = 'searchset') or (type = 'history')",
"xpath" : "not(f:total) or (f:type/@value = 'searchset') or (f:type/@value = 'history')"
},
{
"key" : "bdl-2",
"severity" : "error",
"human" : "entry.search only when a search",
"expression" : "entry.search.empty() or (type = 'searchset')",
"xpath" : "not(f:entry/f:search) or (f:type/@value = 'searchset')"
},
{
"key" : "bdl-11",
"severity" : "error",
"human" : "A document must have a Composition as the first resource",
"expression" : "type = 'document' implies entry.first().resource.is(Composition)",
"xpath" : "not(f:type/@value='document') or f:entry[1]/f:resource/f:Composition"
},
{
"key" : "bdl-10",
"severity" : "error",
"human" : "A document must have a date",
"expression" : "type = 'document' implies (meta.lastUpdated.hasValue())",
"xpath" : "not(f:type/@value = 'document') or exists(f:meta/f:lastUpdated/f:value)"
}],
"mapping" : [{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "N/A"
},
{
"identity" : "cda",
"map" : "ClinicalDocument, if bundle.type = document"
}]
},
{
"id" : "Bundle.identifier",
"path" : "Bundle.identifier",
"short" : "Persistent identifier for the bundle",
"definition" : "A persistent identifier for the bundle that won't change as a bundle is copied from server to server.",
"comment" : "Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "cda",
"map" : "ClinicalDocument.id"
}]
},
{
"id" : "Bundle.type",
"path" : "Bundle.type",
"short" : "document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection",
"definition" : "Indicates the purpose of this bundle - how it is intended to be used.",
"comment" : "It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BundleType"
}],
"strength" : "required",
"description" : "Indicates the purpose of a bundle - how it is intended to be used.",
"valueSet" : "http://hl7.org/fhir/ValueSet/bundle-type|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Bundle.timestamp",
"path" : "Bundle.timestamp",
"short" : "When the bundle was assembled",
"definition" : "The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.",
"comment" : "For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated. \n\nUsage:\n\n* document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time\n* message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message\n* history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates\n* searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query\n* transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning\n\nThe timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "instant"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.init"
},
{
"identity" : "cda",
"map" : "ClinicalDocument.effectiveTime"
}]
},
{
"id" : "Bundle.total",
"path" : "Bundle.total",
"short" : "If search, the total number of matches",
"definition" : "If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.",
"comment" : "Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "unsignedInt"
}],
"condition" : ["bdl-1"],
"isSummary" : true
},
{
"id" : "Bundle.link",
"path" : "Bundle.link",
"short" : "Links related to this Bundle",
"definition" : "A series of links that provide context to this bundle.",
"comment" : "Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)). \n\nBundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.\n\nThis specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "Bundle.link.relation",
"path" : "Bundle.link.relation",
"short" : "See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1",
"definition" : "A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1).",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "Bundle.link.url",
"path" : "Bundle.link.url",
"short" : "Reference details for the link",
"definition" : "The reference details for the link.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true
},
{
"id" : "Bundle.entry",
"path" : "Bundle.entry",
"short" : "Entry in the bundle - will have a resource or information",
"definition" : "An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"orderMeaning" : "For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type",
"constraint" : [{
"key" : "bdl-8",
"severity" : "error",
"human" : "fullUrl cannot be a version specific reference",
"expression" : "fullUrl.contains('/_history/').not()",
"xpath" : "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))"
},
{
"key" : "bdl-5",
"severity" : "error",
"human" : "must be a resource unless there's a request or response",
"expression" : "resource.exists() or request.exists() or response.exists()",
"xpath" : "exists(f:resource) or exists(f:request) or exists(f:response)"
}],
"isSummary" : true
},
{
"id" : "Bundle.entry.link",
"path" : "Bundle.entry.link",
"short" : "Links related to this entry",
"definition" : "A series of links that provide context to this entry.",
"min" : 0,
"max" : "*",
"contentReference" : "#Bundle.link",
"isSummary" : true
},
{
"id" : "Bundle.entry.fullUrl",
"path" : "Bundle.entry.fullUrl",
"short" : "URI for resource (Absolute URL server address or URI for UUID/OID)",
"definition" : "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.",
"comment" : "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true
},
{
"id" : "Bundle.entry.resource",
"path" : "Bundle.entry.resource",
"short" : "A resource in the bundle",
"definition" : "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Resource"
}],
"isSummary" : true
},
{
"id" : "Bundle.entry.search",
"path" : "Bundle.entry.search",
"short" : "Search related information",
"definition" : "Information about the search process that lead to the creation of this entry.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["bdl-2"],
"isSummary" : true
},
{
"id" : "Bundle.entry.search.mode",
"path" : "Bundle.entry.search.mode",
"short" : "match | include | outcome - why this is in the result set",
"definition" : "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.",
"comment" : "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SearchEntryMode"
}],
"strength" : "required",
"description" : "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.",
"valueSet" : "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.0"
}
},
{
"id" : "Bundle.entry.search.score",
"path" : "Bundle.entry.search.score",
"short" : "Search ranking (between 0 and 1)",
"definition" : "When searching, the server's search ranking score for the entry.",
"comment" : "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}],
"isSummary" : true
},
{
"id" : "Bundle.entry.request",
"path" : "Bundle.entry.request",
"short" : "Additional execution information (transaction/batch/history)",
"definition" : "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["bdl-3"],
"isSummary" : true
},
{
"id" : "Bundle.entry.request.method",
"path" : "Bundle.entry.request.method",
"short" : "GET | HEAD | POST | PUT | DELETE | PATCH",
"definition" : "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "HTTPVerb"
}],
"strength" : "required",
"description" : "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.",
"valueSet" : "http://hl7.org/fhir/ValueSet/http-verb|4.0.0"
}
},
{
"id" : "Bundle.entry.request.url",
"path" : "Bundle.entry.request.url",
"short" : "URL for HTTP equivalent of this entry",
"definition" : "The URL for this entry, relative to the root (the address to which the request is posted).",
"comment" : "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true
},
{
"id" : "Bundle.entry.request.ifNoneMatch",
"path" : "Bundle.entry.request.ifNoneMatch",
"short" : "For managing cache currency",
"definition" : "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "Bundle.entry.request.ifModifiedSince",
"path" : "Bundle.entry.request.ifModifiedSince",
"short" : "For managing cache currency",
"definition" : "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "instant"
}],
"isSummary" : true
},
{
"id" : "Bundle.entry.request.ifMatch",
"path" : "Bundle.entry.request.ifMatch",
"short" : "For managing update contention",
"definition" : "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "Bundle.entry.request.ifNoneExist",
"path" : "Bundle.entry.request.ifNoneExist",
"short" : "For conditional creates",
"definition" : "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "Bundle.entry.response",
"path" : "Bundle.entry.response",
"short" : "Results of execution (transaction/batch/history)",
"definition" : "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["bdl-4"],
"isSummary" : true
},
{
"id" : "Bundle.entry.response.status",
"path" : "Bundle.entry.response.status",
"short" : "Status response code (text optional)",
"definition" : "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "Bundle.entry.response.location",
"path" : "Bundle.entry.response.location",
"short" : "The location (if the operation returns a location)",
"definition" : "The location header created by processing this operation, populated if the operation returns a location.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true
},
{
"id" : "Bundle.entry.response.etag",
"path" : "Bundle.entry.response.etag",
"short" : "The Etag for the resource (if relevant)",
"definition" : "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).",
"comment" : "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "Bundle.entry.response.lastModified",
"path" : "Bundle.entry.response.lastModified",
"short" : "Server's date time modified",
"definition" : "The date/time that the resource was modified on the server.",
"comment" : "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "instant"
}],
"isSummary" : true
},
{
"id" : "Bundle.entry.response.outcome",
"path" : "Bundle.entry.response.outcome",
"short" : "OperationOutcome with hints and warnings (for batch/transaction)",
"definition" : "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.",
"comment" : "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Resource"
}],
"isSummary" : true
},
{
"id" : "Bundle.signature",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "Bundle.signature",
"short" : "Digital Signature",
"definition" : "Digital Signature - base64 encoded. XML-DSig or a JWT.",
"comment" : "The signature could be created by the \"author\" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.",
"requirements" : "A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Signature"
}],
"isSummary" : true
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/CapabilityStatement",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "CapabilityStatement",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints CapabilityStatement IN DomainResource A statement of system capabilities
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
+ Rule: A Capability Statement SHALL have at least one of REST, messaging or document element.
+ Rule: A Capability Statement SHALL have at least one of description, software, or implementation element.
+ Rule: Messaging end-point is required (and is only permitted) when a statement is for an implementation.
+ Rule: The set of documents must be unique by the combination of profile and mode.
+ Rule: If kind = instance, implementation must be present and software may be present
+ Rule: If kind = capability, implementation must be absent, software must be present
+ Rule: If kind = requirements, implementation and software must be absent
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension \r\n url Σ 0..1 uri Canonical identifier for this capability statement, represented as a URI (globally unique) \r\n version Σ 0..1 string Business version of the capability statement \r\n name ΣI 0..1 string Name for this capability statement (computer friendly) \r\n title Σ 0..1 string Name for this capability statement (human friendly) \r\n status ?!Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required) \r\n experimental Σ 0..1 boolean For testing purposes, not real usage \r\n date Σ 1..1 dateTime Date last changed \r\n publisher Σ 0..1 string Name of the publisher (organization or individual) \r\n contact Σ 0..* ContactDetail Contact details for the publisher
\r\n description I 0..1 markdown Natural language description of the capability statement \r\n useContext ΣTU 0..* UsageContext The context that the content is intended to support
\r\n jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for capability statement (if applicable)
Jurisdiction (Extensible)
\r\n purpose 0..1 markdown Why this capability statement is defined \r\n copyright 0..1 markdown Use and/or publishing restrictions \r\n kind ΣI 1..1 code instance | capability | requirements
CapabilityStatementKind (Required) \r\n instantiates Σ 0..* canonical(CapabilityStatement) Canonical URL of another capability statement this implements
\r\n imports ΣTU 0..* canonical(CapabilityStatement) Canonical URL of another capability statement this adds to
\r\n software ΣI 0..1 BackboneElement Software that is covered by this capability statement \r\n name Σ 1..1 string A name the software is known by \r\n version Σ 0..1 string Version covered by this statement \r\n releaseDate Σ 0..1 dateTime Date this version was released \r\n implementation ΣI 0..1 BackboneElement If this describes a specific instance \r\n description Σ 1..1 string Describes this specific instance \r\n url Σ 0..1 url Base URL for the installation \r\n custodian ΣTU 0..1 Reference(Organization) Organization that manages the data \r\n fhirVersion Σ 1..1 code FHIR Version the system supports
FHIRVersion (Required) \r\n format Σ 1..* code formats supported (xml | json | ttl | mime type)
MimeType (Required)
\r\n patchFormat Σ 0..* code Patch formats supported
MimeType (Required)
\r\n implementationGuide Σ 0..* canonical(ImplementationGuide) Implementation guides supported
\r\n rest ΣI 0..* BackboneElement If the endpoint is a RESTful one
+ Rule: A given resource can only be described once per RESTful mode.
\r\n mode Σ 1..1 code client | server
RestfulCapabilityMode (Required) \r\n documentation 0..1 markdown General description of implementation \r\n security ΣTU 0..1 BackboneElement Information about security of implementation \r\n cors Σ 0..1 boolean Adds CORS Headers (http://enable-cors.org/) \r\n service Σ 0..* CodeableConcept OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
RestfulSecurityService (Extensible)
\r\n description 0..1 markdown General description of how security works \r\n resource ΣI 0..* BackboneElement Resource served on the REST interface
+ Rule: Search parameter names must be unique in the context of a resource.
\r\n type Σ 1..1 code A resource type that is supported
ResourceType (Required) \r\n profile Σ 0..1 canonical(StructureDefinition) Base System profile for all uses of resource \r\n supportedProfile ΣTU 0..* canonical(StructureDefinition) Profiles for use cases supported
\r\n documentation 0..1 markdown Additional information about the use of the resource type \r\n interaction 0..* BackboneElement What operations are supported?
\r\n code 1..1 code read | vread | update | patch | delete | history-instance | history-type | create | search-type
TypeRestfulInteraction (Required) \r\n documentation 0..1 markdown Anything special about operation behavior \r\n versioning TU 0..1 code no-version | versioned | versioned-update
ResourceVersionPolicy (Required) \r\n readHistory TU 0..1 boolean Whether vRead can return past versions \r\n updateCreate TU 0..1 boolean If update can commit to a new identity \r\n conditionalCreate TU 0..1 boolean If allows/uses conditional create \r\n conditionalRead TU 0..1 code not-supported | modified-since | not-match | full-support
ConditionalReadStatus (Required) \r\n conditionalUpdate TU 0..1 boolean If allows/uses conditional update \r\n conditionalDelete TU 0..1 code not-supported | single | multiple - how conditional delete is supported
ConditionalDeleteStatus (Required) \r\n referencePolicy TU 0..* code literal | logical | resolves | enforced | local
ReferenceHandlingPolicy (Required)
\r\n searchInclude TU 0..* string _include values supported by the server
\r\n searchRevInclude TU 0..* string _revinclude values supported by the server
\r\n searchParam 0..* BackboneElement Search parameters supported by implementation
\r\n name 1..1 string Name of search parameter \r\n definition 0..1 canonical(SearchParameter) Source of definition for parameter \r\n type 1..1 code number | date | string | token | reference | composite | quantity | uri | special
SearchParamType (Required) \r\n documentation 0..1 markdown Server-specific usage \r\n operation Σ 0..* BackboneElement Definition of a resource operation
\r\n name Σ 1..1 string Name by which the operation/query is invoked \r\n definition Σ 1..1 canonical(OperationDefinition) The defined operation/query \r\n documentation 0..1 markdown Specific details about operation behavior \r\n interaction 0..* BackboneElement What operations are supported?
\r\n code 1..1 code transaction | batch | search-system | history-system
SystemRestfulInteraction (Required) \r\n documentation 0..1 markdown Anything special about operation behavior \r\n searchParam 0..* see searchParam Search parameters for searching all resources
\r\n operation Σ 0..* see operation Definition of a system level operation
\r\n compartment 0..* canonical(CompartmentDefinition) Compartments served/used by system
\r\n messaging ΣITU 0..* BackboneElement If messaging is supported
\r\n endpoint 0..* BackboneElement Where messages should be sent
\r\n protocol 1..1 Coding http | ftp | mllp +
MessageTransport (Extensible) \r\n address 1..1 url Network address or identifier of the end-point \r\n reliableCache 0..1 unsignedInt Reliable Message Cache Length (min) \r\n documentation 0..1 markdown Messaging interface behavior details \r\n supportedMessage Σ 0..* BackboneElement Messages supported by this system
\r\n mode Σ 1..1 code sender | receiver
EventCapabilityMode (Required) \r\n definition Σ 1..1 canonical(MessageDefinition) Message supported by this system \r\n document ΣITU 0..* BackboneElement Document definition
\r\n mode Σ 1..1 code producer | consumer
DocumentMode (Required) \r\n documentation 0..1 markdown Description of document support \r\n profile Σ 1..1 canonical(StructureDefinition) Constraint on the resources used in the document \r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Conformance"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/CapabilityStatement",
"version" : "4.0.0",
"name" : "CapabilityStatement",
"status" : "active",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}]
}],
"description" : "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "objimpl",
"uri" : "http://hl7.org/fhir/object-implementation",
"name" : "Object Implementation Information"
}],
"kind" : "resource",
"abstract" : false,
"type" : "CapabilityStatement",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString" : "MetadataResource"
}]
},
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "CapabilityStatement",
"path" : "CapabilityStatement",
"short" : "A statement of system capabilities",
"definition" : "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"comment" : "Applications may implement multiple versions (see [Managing Multiple Versions](versioning.html), and the [$versions](capabilitystatement-operation-versions.html) operation). If they do, then a CapabilityStatement describes the system's support for a particular version of FHIR, and the server will have multiple statements, one for each version.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
},
{
"key" : "cpb-7",
"severity" : "error",
"human" : "The set of documents must be unique by the combination of profile and mode.",
"expression" : "document.select(profile&mode).isDistinct()",
"xpath" : "count(f:document[f:mode/@value='producer'])=count(distinct-values(f:document[f:mode/@value='producer']/f:profile/f:reference/@value)) and count(f:document[f:mode/@value='consumer'])=count(distinct-values(f:document[f:mode/@value='consumer']/f:profile/f:reference/@value))"
},
{
"key" : "cpb-16",
"severity" : "error",
"human" : "If kind = requirements, implementation and software must be absent",
"expression" : "(kind!='requirements') or (implementation.exists().not() and software.exists().not())",
"xpath" : "not(f:kind/@value='instance') or (not(exists(f:implementation)) and not(exists(f:software)))"
},
{
"key" : "cpb-15",
"severity" : "error",
"human" : "If kind = capability, implementation must be absent, software must be present",
"expression" : "(kind != 'capability') or (implementation.exists().not() and software.exists())",
"xpath" : " not(f:kind/@value='instance') or (not(exists(f:implementation)) and exists(f:software))"
},
{
"key" : "cpb-3",
"severity" : "error",
"human" : "Messaging end-point is required (and is only permitted) when a statement is for an implementation.",
"expression" : "messaging.endpoint.empty() or kind = 'instance'",
"xpath" : "not(exists(f:messaging/f:endpoint)) or f:kind/@value = 'instance'"
},
{
"key" : "cpb-14",
"severity" : "error",
"human" : "If kind = instance, implementation must be present and software may be present",
"expression" : "(kind != 'instance') or implementation.exists()",
"xpath" : "not(f:kind/@value='instance') or exists(f:implementation)"
},
{
"key" : "cpb-2",
"severity" : "error",
"human" : "A Capability Statement SHALL have at least one of description, software, or implementation element.",
"expression" : "(description.count() + software.count() + implementation.count()) > 0",
"xpath" : "count(f:software | f:implementation | f:description) > 0"
},
{
"key" : "cpb-1",
"severity" : "error",
"human" : "A Capability Statement SHALL have at least one of REST, messaging or document element.",
"expression" : "rest.exists() or messaging.exists() or document.exists()",
"xpath" : "exists(f:rest) or exists(f:messaging) or exists(f:document)"
},
{
"key" : "cpb-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.id",
"path" : "CapabilityStatement.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.meta",
"path" : "CapabilityStatement.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.implicitRules",
"path" : "CapabilityStatement.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "CapabilityStatement.language",
"path" : "CapabilityStatement.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "CapabilityStatement.text",
"path" : "CapabilityStatement.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "CapabilityStatement.contained",
"path" : "CapabilityStatement.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement.extension",
"path" : "CapabilityStatement.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement.modifierExtension",
"path" : "CapabilityStatement.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement.url",
"path" : "CapabilityStatement.url",
"short" : "Canonical identifier for this capability statement, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this capability statement is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the capability statement to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.url",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "CapabilityStatement.version",
"path" : "CapabilityStatement.version",
"short" : "Business version of the capability statement",
"definition" : "The identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different capability statement instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the capability statement with the format [url]|[version].",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "CapabilityStatement.name",
"path" : "CapabilityStatement.name",
"short" : "Name for this capability statement (computer friendly)",
"definition" : "A natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.title",
"path" : "CapabilityStatement.title",
"short" : "Name for this capability statement (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the capability statement.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "CapabilityStatement.status",
"path" : "CapabilityStatement.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this capability statement. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of capability statements that are appropriate for use versus not.This is not intended for use with actual capability statements, but where capability statements are used to describe possible or desired systems.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "CapabilityStatement.experimental",
"path" : "CapabilityStatement.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of capability statements that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level capability statement.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.experimental",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "CapabilityStatement.date",
"path" : "CapabilityStatement.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the capability statement was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the capability statement. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.date",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "CapabilityStatement.publisher",
"path" : "CapabilityStatement.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the capability statement.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the capability statement is the organization or individual primarily responsible for the maintenance and upkeep of the capability statement. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the capability statement. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the capability statement. May also allow for contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "CapabilityStatement.contact",
"path" : "CapabilityStatement.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "CapabilityStatement.description",
"path" : "CapabilityStatement.description",
"short" : "Natural language description of the capability statement",
"definition" : "A free text natural language description of the capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.",
"comment" : "This description can be used to capture details such as why the capability statement was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the capability statement as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the capability statement is presumed to be the predominant language in the place the capability statement was created).This does not need to be populated if the description is adequately implied by the software or implementation details.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"condition" : ["cpb-2"],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "CapabilityStatement.useContext",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate capability statement instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "CapabilityStatement.jurisdiction",
"path" : "CapabilityStatement.jurisdiction",
"short" : "Intended jurisdiction for capability statement (if applicable)",
"definition" : "A legal or geographic region in which the capability statement is intended to be used.",
"comment" : "It may be possible for the capability statement to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "CapabilityStatement.purpose",
"path" : "CapabilityStatement.purpose",
"short" : "Why this capability statement is defined",
"definition" : "Explanation of why this capability statement is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the capability statement. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this capability statement.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.purpose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "CapabilityStatement.copyright",
"path" : "CapabilityStatement.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the capability statement and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.copyright",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "CapabilityStatement.kind",
"path" : "CapabilityStatement.kind",
"short" : "instance | capability | requirements",
"definition" : "The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).",
"requirements" : "Allow searching the 3 modes.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.kind",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"condition" : ["cpb-15"],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CapabilityStatementKind"
}],
"strength" : "required",
"description" : "How a capability statement is intended to be used.",
"valueSet" : "http://hl7.org/fhir/ValueSet/capability-statement-kind|4.0.0"
}
},
{
"id" : "CapabilityStatement.instantiates",
"path" : "CapabilityStatement.instantiates",
"short" : "Canonical URL of another capability statement this implements",
"definition" : "Reference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details.",
"comment" : "HL7 defines the following Services: [Terminology Service](terminology-service.html). \n\nMany [Implementation Guides](http://fhir.org/guides/registry) define additional services.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.instantiates",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CapabilityStatement"]
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.imports",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.imports",
"short" : "Canonical URL of another capability statement this adds to",
"definition" : "Reference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them.",
"comment" : "the contents of any directly or indirectly imported CapabilityStatements SHALL NOT overlap, i.e. they cannot refer to the same rest/resource, operations/name, searchparam/name, interaction/code, messaging/endpoint, document/mode pair.\n\nA capability statement that imports another CapabilityStatement automatically instantiates it too (though this is often not a very useful statement for the kinds of CapabilityStatements that are suitable for importing).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.imports",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CapabilityStatement"]
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.software",
"path" : "CapabilityStatement.software",
"short" : "Software that is covered by this capability statement",
"definition" : "Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.software",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["cpb-2"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.software.id",
"path" : "CapabilityStatement.software.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.software.extension",
"path" : "CapabilityStatement.software.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.software.modifierExtension",
"path" : "CapabilityStatement.software.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement.software.name",
"path" : "CapabilityStatement.software.name",
"short" : "A name the software is known by",
"definition" : "Name the software is known by.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.software.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.software.version",
"path" : "CapabilityStatement.software.version",
"short" : "Version covered by this statement",
"definition" : "The version identifier for the software covered by this statement.",
"comment" : "If possible, a version should be specified, as statements are likely to be different for different versions of software.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.software.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.software.releaseDate",
"path" : "CapabilityStatement.software.releaseDate",
"short" : "Date this version was released",
"definition" : "Date this version of the software was released.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.software.releaseDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.implementation",
"path" : "CapabilityStatement.implementation",
"short" : "If this describes a specific instance",
"definition" : "Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.implementation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["cpb-2",
"cpb-15"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.implementation.id",
"path" : "CapabilityStatement.implementation.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.implementation.extension",
"path" : "CapabilityStatement.implementation.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.implementation.modifierExtension",
"path" : "CapabilityStatement.implementation.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement.implementation.description",
"path" : "CapabilityStatement.implementation.description",
"short" : "Describes this specific instance",
"definition" : "Information about the specific installation that this capability statement relates to.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.implementation.description",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.implementation.url",
"path" : "CapabilityStatement.implementation.url",
"short" : "Base URL for the installation",
"definition" : "An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.implementation.url",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "url"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.implementation.custodian",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.implementation.custodian",
"short" : "Organization that manages the data",
"definition" : "The organization responsible for the management of the instance and oversight of the data on the server at the specified URL.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.implementation.custodian",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.fhirVersion",
"path" : "CapabilityStatement.fhirVersion",
"short" : "FHIR Version the system supports",
"definition" : "The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value.",
"comment" : "Servers may implement multiple versions (see [Managing Multiple Versions](versioning.html), and the [$versions](capabilitystatement-operation-versions.html) operation). If they do, and the CapabilityStatement is requested from the server, then this fhirVersion will be either the version requested, or the server's default version.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.fhirVersion",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRVersion"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "All published FHIR Versions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/FHIR-version|4.0.0"
}
},
{
"id" : "CapabilityStatement.format",
"path" : "CapabilityStatement.format",
"short" : "formats supported (xml | json | ttl | mime type)",
"definition" : "A list of the formats supported by this implementation using their content types.",
"comment" : "\"xml\", \"json\" and \"ttl\" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.format",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MimeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The mime type of an attachment. Any valid mime type is allowed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|4.0.0"
}
},
{
"id" : "CapabilityStatement.patchFormat",
"path" : "CapabilityStatement.patchFormat",
"short" : "Patch formats supported",
"definition" : "A list of the patch formats supported by this implementation using their content types.",
"comment" : "At present, the patch mime types application/json-patch+json and application/xml-patch+xml are legal. Generally, if a server supports PATCH, it would be expected to support the patch formats and match the formats it supports, but this is not always possible or necessary.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.patchFormat",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MimeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The mime type of an attachment. Any valid mime type is allowed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|4.0.0"
}
},
{
"id" : "CapabilityStatement.implementationGuide",
"path" : "CapabilityStatement.implementationGuide",
"short" : "Implementation guides supported",
"definition" : "A list of implementation guides that the server does (or should) support in their entirety.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.implementationGuide",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ImplementationGuide"]
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.rest",
"path" : "CapabilityStatement.rest",
"short" : "If the endpoint is a RESTful one",
"definition" : "A definition of the restful capabilities of the solution, if any.",
"comment" : "Multiple repetitions allow definition of both client and/or server behaviors or possibly behaviors under different configuration settings (for software or requirements statements).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.rest",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["cpb-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "cpb-9",
"severity" : "error",
"human" : "A given resource can only be described once per RESTful mode.",
"expression" : "resource.select(type).isDistinct()",
"xpath" : "count(f:resource)=count(distinct-values(f:resource/f:type/@value))"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.rest.id",
"path" : "CapabilityStatement.rest.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.rest.extension",
"path" : "CapabilityStatement.rest.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.rest.modifierExtension",
"path" : "CapabilityStatement.rest.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement.rest.mode",
"path" : "CapabilityStatement.rest.mode",
"short" : "client | server",
"definition" : "Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.mode",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RestfulCapabilityMode"
}],
"strength" : "required",
"description" : "The mode of a RESTful capability statement.",
"valueSet" : "http://hl7.org/fhir/ValueSet/restful-capability-mode|4.0.0"
}
},
{
"id" : "CapabilityStatement.rest.documentation",
"path" : "CapabilityStatement.rest.documentation",
"short" : "General description of implementation",
"definition" : "Information about the system's restful capabilities that apply across all applications, such as security.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.documentation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement.rest.security",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.rest.security",
"short" : "Information about security of implementation",
"definition" : "Information about security implementation from an interface perspective - what a client needs to know.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.security",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.rest.security.id",
"path" : "CapabilityStatement.rest.security.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.rest.security.extension",
"path" : "CapabilityStatement.rest.security.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.rest.security.modifierExtension",
"path" : "CapabilityStatement.rest.security.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement.rest.security.cors",
"path" : "CapabilityStatement.rest.security.cors",
"short" : "Adds CORS Headers (http://enable-cors.org/)",
"definition" : "Server adds CORS headers when responding to requests - this enables Javascript applications to use the server.",
"comment" : "The easiest CORS headers to add are Access-Control-Allow-Origin: * & Access-Control-Request-Method: GET, POST, PUT, DELETE. All servers SHOULD support CORS.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.security.cors",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.rest.security.service",
"path" : "CapabilityStatement.rest.security.service",
"short" : "OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates",
"definition" : "Types of security services that are supported/required by the system.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.rest.security.service",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RestfulSecurityService"
}],
"strength" : "extensible",
"description" : "Types of security services used with FHIR.",
"valueSet" : "http://hl7.org/fhir/ValueSet/restful-security-service"
}
},
{
"id" : "CapabilityStatement.rest.security.description",
"path" : "CapabilityStatement.rest.security.description",
"short" : "General description of how security works",
"definition" : "General description of how security works.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.security.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement.rest.resource",
"path" : "CapabilityStatement.rest.resource",
"short" : "Resource served on the REST interface",
"definition" : "A specification of the restful capabilities of the solution for a specific resource type.",
"comment" : "Max of one repetition per resource type.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.rest.resource",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "cpb-12",
"severity" : "error",
"human" : "Search parameter names must be unique in the context of a resource.",
"expression" : "searchParam.select(name).isDistinct()",
"xpath" : "count(f:searchParam)=count(distinct-values(f:searchParam/f:name/@value))"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.rest.resource.id",
"path" : "CapabilityStatement.rest.resource.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.rest.resource.extension",
"path" : "CapabilityStatement.rest.resource.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.rest.resource.modifierExtension",
"path" : "CapabilityStatement.rest.resource.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement.rest.resource.type",
"path" : "CapabilityStatement.rest.resource.type",
"short" : "A resource type that is supported",
"definition" : "A type of resource exposed via the restful interface.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.resource.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResourceType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "One of the resource types defined as part of this version of FHIR.",
"valueSet" : "http://hl7.org/fhir/ValueSet/resource-types|4.0.0"
}
},
{
"id" : "CapabilityStatement.rest.resource.profile",
"path" : "CapabilityStatement.rest.resource.profile",
"short" : "Base System profile for all uses of resource",
"definition" : "A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles](profiling.html#profile-uses).",
"comment" : "The profile applies to all resources of this type - i.e. it is the superset of what is supported by the system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.resource.profile",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.rest.resource.supportedProfile",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.rest.resource.supportedProfile",
"short" : "Profiles for use cases supported",
"definition" : "A list of profiles that represent different use cases supported by the system. For a server, \"supported by the system\" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses).",
"comment" : "Supported profiles are different than the profile that applies to a particular resource in .rest.resource.profile. The resource profile is a general statement of what features of the resource are supported overall by the system - the sum total of the facilities it supports. A supported profile is a deeper statement about the functionality of the data and services provided by the server (or used by the client). A typical case is a laboratory system that produces a set of different reports - this is the list of types of data that it publishes. A key aspect of declaring profiles here is the question of how the client converts knowledge that the server publishes this data into working with the data; the client can inspect individual resources to determine whether they conform to a particular profile, but how does it find the ones that do? It does so by searching using the _profile parameter, so any resources listed here must be valid values for the _profile resource (using the identifier in the target profile).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.rest.resource.supportedProfile",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.rest.resource.documentation",
"path" : "CapabilityStatement.rest.resource.documentation",
"short" : "Additional information about the use of the resource type",
"definition" : "Additional information about the resource type used by the system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.resource.documentation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement.rest.resource.interaction",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "ResourceInteraction"
}],
"path" : "CapabilityStatement.rest.resource.interaction",
"short" : "What operations are supported?",
"definition" : "Identifies a restful operation supported by the solution.",
"comment" : "In general, a Resource will only appear in a CapabilityStatement if the server actually has some capabilities - e.g. there is at least one interaction supported. However interactions can be omitted to support summarization (_summary = true).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.rest.resource.interaction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement.rest.resource.interaction.id",
"path" : "CapabilityStatement.rest.resource.interaction.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.rest.resource.interaction.extension",
"path" : "CapabilityStatement.rest.resource.interaction.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.rest.resource.interaction.modifierExtension",
"path" : "CapabilityStatement.rest.resource.interaction.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement.rest.resource.interaction.code",
"path" : "CapabilityStatement.rest.resource.interaction.code",
"short" : "read | vread | update | patch | delete | history-instance | history-type | create | search-type",
"definition" : "Coded identifier of the operation, supported by the system resource.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.resource.interaction.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TypeRestfulInteraction"
}],
"strength" : "required",
"description" : "Operations supported by REST at the type or instance level.",
"valueSet" : "http://hl7.org/fhir/ValueSet/type-restful-interaction|4.0.0"
}
},
{
"id" : "CapabilityStatement.rest.resource.interaction.documentation",
"path" : "CapabilityStatement.rest.resource.interaction.documentation",
"short" : "Anything special about operation behavior",
"definition" : "Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'.",
"requirements" : "REST allows a degree of variability in the implementation of RESTful solutions that is useful for exchange partners to be aware of.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.resource.interaction.documentation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement.rest.resource.versioning",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.rest.resource.versioning",
"short" : "no-version | versioned | versioned-update",
"definition" : "This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API.",
"comment" : "If a server supports versionIds correctly, it SHOULD support vread too, but is not required to do so.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.resource.versioning",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResourceVersionPolicy"
}],
"strength" : "required",
"description" : "How the system supports versioning for a resource.",
"valueSet" : "http://hl7.org/fhir/ValueSet/versioning-policy|4.0.0"
}
},
{
"id" : "CapabilityStatement.rest.resource.readHistory",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.rest.resource.readHistory",
"short" : "Whether vRead can return past versions",
"definition" : "A flag for whether the server is able to return past versions as part of the vRead operation.",
"comment" : "It is useful to support the vRead operation for current operations, even if past versions aren't available.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.resource.readHistory",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement.rest.resource.updateCreate",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.rest.resource.updateCreate",
"short" : "If update can commit to a new identity",
"definition" : "A flag to indicate that the server allows or needs to allow the client to create new identities on the server (that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server.",
"comment" : "Allowing the clients to create new identities on the server means that the system administrator needs to have confidence that the clients do not create clashing identities between them. Obviously, if there is only one client, this won't happen. While creating identities on the client means that the clients need to be managed, it's much more convenient for many scenarios if such management can be put in place.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.resource.updateCreate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement.rest.resource.conditionalCreate",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.rest.resource.conditionalCreate",
"short" : "If allows/uses conditional create",
"definition" : "A flag that indicates that the server supports conditional create.",
"comment" : "Conditional Create is mainly appropriate for interface engine scripts converting from other formats, such as v2.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.resource.conditionalCreate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement.rest.resource.conditionalRead",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.rest.resource.conditionalRead",
"short" : "not-supported | modified-since | not-match | full-support",
"definition" : "A code that indicates how the server supports conditional read.",
"comment" : "Conditional Read is mainly appropriate for interface engine scripts converting from other formats, such as v2.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.resource.conditionalRead",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConditionalReadStatus"
}],
"strength" : "required",
"description" : "A code that indicates how the server supports conditional read.",
"valueSet" : "http://hl7.org/fhir/ValueSet/conditional-read-status|4.0.0"
}
},
{
"id" : "CapabilityStatement.rest.resource.conditionalUpdate",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.rest.resource.conditionalUpdate",
"short" : "If allows/uses conditional update",
"definition" : "A flag that indicates that the server supports conditional update.",
"comment" : "Conditional Update is mainly appropriate for interface engine scripts converting from other formats, such as v2.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.resource.conditionalUpdate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement.rest.resource.conditionalDelete",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.rest.resource.conditionalDelete",
"short" : "not-supported | single | multiple - how conditional delete is supported",
"definition" : "A code that indicates how the server supports conditional delete.",
"comment" : "Conditional Delete is mainly appropriate for interface engine scripts converting from other formats, such as v2.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.resource.conditionalDelete",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConditionalDeleteStatus"
}],
"strength" : "required",
"description" : "A code that indicates how the server supports conditional delete.",
"valueSet" : "http://hl7.org/fhir/ValueSet/conditional-delete-status|4.0.0"
}
},
{
"id" : "CapabilityStatement.rest.resource.referencePolicy",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.rest.resource.referencePolicy",
"short" : "literal | logical | resolves | enforced | local",
"definition" : "A set of flags that defines how references are supported.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.rest.resource.referencePolicy",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ReferenceHandlingPolicy"
}],
"strength" : "required",
"description" : "A set of flags that defines how references are supported.",
"valueSet" : "http://hl7.org/fhir/ValueSet/reference-handling-policy|4.0.0"
}
},
{
"id" : "CapabilityStatement.rest.resource.searchInclude",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.rest.resource.searchInclude",
"short" : "_include values supported by the server",
"definition" : "A list of _include values supported by the server.",
"comment" : "If this list is empty, the server does not support includes.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.rest.resource.searchInclude",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement.rest.resource.searchRevInclude",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.rest.resource.searchRevInclude",
"short" : "_revinclude values supported by the server",
"definition" : "A list of _revinclude (reverse include) values supported by the server.",
"comment" : "If this list is empty, the server does not support reverse includes.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.rest.resource.searchRevInclude",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement.rest.resource.searchParam",
"path" : "CapabilityStatement.rest.resource.searchParam",
"short" : "Search parameters supported by implementation",
"definition" : "Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.",
"comment" : "The search parameters should include the control search parameters such as _sort, _count, etc. that also apply to this resource (though many will be listed at [CapabilityStatement.rest.searchParam](capabilitystatement-definitions.html#CapabilityStatement.rest.searchParam)). The behavior of some search parameters may be further described by other code or extension elements, or narrative within the capability statement or linked [SearchParameter](searchparameter.html#) definitions.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.rest.resource.searchParam",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement.rest.resource.searchParam.id",
"path" : "CapabilityStatement.rest.resource.searchParam.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.rest.resource.searchParam.extension",
"path" : "CapabilityStatement.rest.resource.searchParam.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.rest.resource.searchParam.modifierExtension",
"path" : "CapabilityStatement.rest.resource.searchParam.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement.rest.resource.searchParam.name",
"path" : "CapabilityStatement.rest.resource.searchParam.name",
"short" : "Name of search parameter",
"definition" : "The name of the search parameter used in the interface.",
"comment" : "Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.resource.searchParam.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement.rest.resource.searchParam.definition",
"path" : "CapabilityStatement.rest.resource.searchParam.definition",
"short" : "Source of definition for parameter",
"definition" : "An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [SearchParameter.url](searchparameter-definitions.html#SearchParameter.url)). This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.",
"comment" : "This SHOULD be present, and matches refers to a SearchParameter by its canonical URL. If systems wish to document their support for modifiers, comparators, target resource types, and chained parameters, they should do using a search parameter resource. This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.resource.searchParam.definition",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SearchParameter"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement.rest.resource.searchParam.type",
"path" : "CapabilityStatement.rest.resource.searchParam.type",
"short" : "number | date | string | token | reference | composite | quantity | uri | special",
"definition" : "The type of value a search parameter refers to, and how the content is interpreted.",
"comment" : "While this can be looked up from the definition, it is included here as a convenience for systems that autogenerate a query interface based on the server capability statement. It SHALL be the same as the type in the search parameter definition.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.resource.searchParam.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SearchParamType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "Data types allowed to be used for search parameters.",
"valueSet" : "http://hl7.org/fhir/ValueSet/search-param-type|4.0.0"
}
},
{
"id" : "CapabilityStatement.rest.resource.searchParam.documentation",
"path" : "CapabilityStatement.rest.resource.searchParam.documentation",
"short" : "Server-specific usage",
"definition" : "This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.resource.searchParam.documentation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement.rest.resource.operation",
"path" : "CapabilityStatement.rest.resource.operation",
"short" : "Definition of a resource operation",
"definition" : "Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters.",
"comment" : "Operations linked from CapabilityStatement.rest.resource.operation must have OperationDefinition.type = true or OperationDefinition.instance = true. \n\nIf an operation that is listed in multiple CapabilityStatement.rest.resource.operation (e.g. for different resource types), then clients should understand that the operation is only supported on the specified resource types, and that may be a subset of those listed in OperationDefinition.resource.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.rest.resource.operation",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.rest.resource.operation.id",
"path" : "CapabilityStatement.rest.resource.operation.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.rest.resource.operation.extension",
"path" : "CapabilityStatement.rest.resource.operation.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.rest.resource.operation.modifierExtension",
"path" : "CapabilityStatement.rest.resource.operation.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement.rest.resource.operation.name",
"path" : "CapabilityStatement.rest.resource.operation.name",
"short" : "Name by which the operation/query is invoked",
"definition" : "The name of the operation or query. For an operation, this is the name prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called.",
"comment" : "The name here SHOULD be the same as the name in the definition, unless there is a name clash and the name cannot be used. The name does not include the \"$\" portion that is always included in the URL.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.resource.operation.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.rest.resource.operation.definition",
"path" : "CapabilityStatement.rest.resource.operation.definition",
"short" : "The defined operation/query",
"definition" : "Where the formal definition can be found. If a server references the base definition of an Operation (i.e. from the specification itself such as ```http://hl7.org/fhir/OperationDefinition/ValueSet-expand```), that means it supports the full capabilities of the operation - e.g. both GET and POST invocation. If it only supports a subset, it must define its own custom [OperationDefinition](operationdefinition.html#) with a 'base' of the original OperationDefinition. The custom definition would describe the specific subset of functionality supported.",
"comment" : "This can be used to build an HTML form to invoke the operation, for instance.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.resource.operation.definition",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/OperationDefinition"]
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.rest.resource.operation.documentation",
"path" : "CapabilityStatement.rest.resource.operation.documentation",
"short" : "Specific details about operation behavior",
"definition" : "Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.resource.operation.documentation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement.rest.interaction",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "SystemInteraction"
}],
"path" : "CapabilityStatement.rest.interaction",
"short" : "What operations are supported?",
"definition" : "A specification of restful operations supported by the system.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.rest.interaction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement.rest.interaction.id",
"path" : "CapabilityStatement.rest.interaction.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.rest.interaction.extension",
"path" : "CapabilityStatement.rest.interaction.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.rest.interaction.modifierExtension",
"path" : "CapabilityStatement.rest.interaction.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement.rest.interaction.code",
"path" : "CapabilityStatement.rest.interaction.code",
"short" : "transaction | batch | search-system | history-system",
"definition" : "A coded identifier of the operation, supported by the system.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.interaction.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SystemRestfulInteraction"
}],
"strength" : "required",
"description" : "Operations supported by REST at the system level.",
"valueSet" : "http://hl7.org/fhir/ValueSet/system-restful-interaction|4.0.0"
}
},
{
"id" : "CapabilityStatement.rest.interaction.documentation",
"path" : "CapabilityStatement.rest.interaction.documentation",
"short" : "Anything special about operation behavior",
"definition" : "Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.rest.interaction.documentation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement.rest.searchParam",
"path" : "CapabilityStatement.rest.searchParam",
"short" : "Search parameters for searching all resources",
"definition" : "Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.",
"comment" : "Typically, the only search parameters supported for all searches are those that apply to all resources - tags, profiles, text search etc. These search parameters should include the control search parameters such as _sort, _count, etc. that also apply to this resource (though many will be listed at [CapabilityStatement.rest.searchParam](capabilitystatement-definitions.html#CapabilityStatement.rest.searchParam)). The behavior of some search parameters may be further described by other code or extension elements, or narrative within the capability statement or linked [SearchParameter](searchparameter.html#) definitions.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.rest.searchParam",
"min" : 0,
"max" : "*"
},
"contentReference" : "#CapabilityStatement.rest.resource.searchParam",
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement.rest.operation",
"path" : "CapabilityStatement.rest.operation",
"short" : "Definition of a system level operation",
"definition" : "Definition of an operation or a named query together with its parameters and their meaning and type.",
"comment" : "CapabilityStatement.rest.operation is for operations invoked at the system level, or for operations that are supported across multiple resource types. Operations linked from CapabilityStatement.rest.operation must have OperationDefinition.system = true, or more than one Operation.resource.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.rest.operation",
"min" : 0,
"max" : "*"
},
"contentReference" : "#CapabilityStatement.rest.resource.operation",
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.rest.compartment",
"path" : "CapabilityStatement.rest.compartment",
"short" : "Compartments served/used by system",
"definition" : "An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL .",
"comment" : "At present, the only defined compartments are at [CompartmentDefinition](compartmentdefinition.html).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.rest.compartment",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CompartmentDefinition"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement.messaging",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.messaging",
"short" : "If messaging is supported",
"definition" : "A description of the messaging capabilities of the solution.",
"comment" : "Multiple repetitions allow the documentation of multiple endpoints per solution.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.messaging",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["cpb-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.messaging.id",
"path" : "CapabilityStatement.messaging.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.messaging.extension",
"path" : "CapabilityStatement.messaging.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.messaging.modifierExtension",
"path" : "CapabilityStatement.messaging.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement.messaging.endpoint",
"path" : "CapabilityStatement.messaging.endpoint",
"short" : "Where messages should be sent",
"definition" : "An endpoint (network accessible address) to which messages and/or replies are to be sent.",
"alias" : ["3"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.messaging.endpoint",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement.messaging.endpoint.id",
"path" : "CapabilityStatement.messaging.endpoint.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.messaging.endpoint.extension",
"path" : "CapabilityStatement.messaging.endpoint.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.messaging.endpoint.modifierExtension",
"path" : "CapabilityStatement.messaging.endpoint.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement.messaging.endpoint.protocol",
"path" : "CapabilityStatement.messaging.endpoint.protocol",
"short" : "http | ftp | mllp +",
"definition" : "A list of the messaging transport protocol(s) identifiers, supported by this endpoint.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.messaging.endpoint.protocol",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Coding"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MessageTransport"
}],
"strength" : "extensible",
"description" : "The protocol used for message transport.",
"valueSet" : "http://hl7.org/fhir/ValueSet/message-transport"
}
},
{
"id" : "CapabilityStatement.messaging.endpoint.address",
"path" : "CapabilityStatement.messaging.endpoint.address",
"short" : "Network address or identifier of the end-point",
"definition" : "The network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifier.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.messaging.endpoint.address",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "url"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement.messaging.reliableCache",
"path" : "CapabilityStatement.messaging.reliableCache",
"short" : "Reliable Message Cache Length (min)",
"definition" : "Length if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender).",
"comment" : "If this value is missing then the application does not implement (receiver) or depend on (sender) reliable messaging.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.messaging.reliableCache",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "unsignedInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement.messaging.documentation",
"path" : "CapabilityStatement.messaging.documentation",
"short" : "Messaging interface behavior details",
"definition" : "Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, the process for becoming an authorized messaging exchange partner.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.messaging.documentation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement.messaging.supportedMessage",
"path" : "CapabilityStatement.messaging.supportedMessage",
"short" : "Messages supported by this system",
"definition" : "References to message definitions for messages this system can send or receive.",
"comment" : "This is a proposed alternative to the messaging.event structure.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.messaging.supportedMessage",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.messaging.supportedMessage.id",
"path" : "CapabilityStatement.messaging.supportedMessage.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.messaging.supportedMessage.extension",
"path" : "CapabilityStatement.messaging.supportedMessage.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.messaging.supportedMessage.modifierExtension",
"path" : "CapabilityStatement.messaging.supportedMessage.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement.messaging.supportedMessage.mode",
"path" : "CapabilityStatement.messaging.supportedMessage.mode",
"short" : "sender | receiver",
"definition" : "The mode of this event declaration - whether application is sender or receiver.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.messaging.supportedMessage.mode",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "EventCapabilityMode"
}],
"strength" : "required",
"description" : "The mode of a message capability statement.",
"valueSet" : "http://hl7.org/fhir/ValueSet/event-capability-mode|4.0.0"
}
},
{
"id" : "CapabilityStatement.messaging.supportedMessage.definition",
"path" : "CapabilityStatement.messaging.supportedMessage.definition",
"short" : "Message supported by this system",
"definition" : "Points to a message definition that identifies the messaging event, message structure, allowed responses, etc.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.messaging.supportedMessage.definition",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MessageDefinition"]
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.document",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.document",
"short" : "Document definition",
"definition" : "A document definition.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CapabilityStatement.document",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["cpb-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CapabilityStatement.document.id",
"path" : "CapabilityStatement.document.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.document.extension",
"path" : "CapabilityStatement.document.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.document.modifierExtension",
"path" : "CapabilityStatement.document.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CapabilityStatement.document.mode",
"path" : "CapabilityStatement.document.mode",
"short" : "producer | consumer",
"definition" : "Mode of this document declaration - whether an application is a producer or consumer.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.document.mode",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DocumentMode"
}],
"strength" : "required",
"description" : "Whether the application produces or consumes documents.",
"valueSet" : "http://hl7.org/fhir/ValueSet/document-mode|4.0.0"
}
},
{
"id" : "CapabilityStatement.document.documentation",
"path" : "CapabilityStatement.document.documentation",
"short" : "Description of document support",
"definition" : "A description of how the application supports or uses the specified document profile. For example, when documents are created, what action is taken with consumed documents, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.document.documentation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CapabilityStatement.document.profile",
"path" : "CapabilityStatement.document.profile",
"short" : "Constraint on the resources used in the document",
"definition" : "A profile on the document Bundle that constrains which resources are present, and their contents.",
"comment" : "The profile is actually on the Bundle.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CapabilityStatement.document.profile",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "CapabilityStatement",
"path" : "CapabilityStatement",
"short" : "A statement of system capabilities",
"definition" : "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"comment" : "Applications may implement multiple versions (see [Managing Multiple Versions](versioning.html), and the [$versions](capabilitystatement-operation-versions.html) operation). If they do, then a CapabilityStatement describes the system's support for a particular version of FHIR, and the server will have multiple statements, one for each version.",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "cpb-7",
"severity" : "error",
"human" : "The set of documents must be unique by the combination of profile and mode.",
"expression" : "document.select(profile&mode).isDistinct()",
"xpath" : "count(f:document[f:mode/@value='producer'])=count(distinct-values(f:document[f:mode/@value='producer']/f:profile/f:reference/@value)) and count(f:document[f:mode/@value='consumer'])=count(distinct-values(f:document[f:mode/@value='consumer']/f:profile/f:reference/@value))"
},
{
"key" : "cpb-16",
"severity" : "error",
"human" : "If kind = requirements, implementation and software must be absent",
"expression" : "(kind!='requirements') or (implementation.exists().not() and software.exists().not())",
"xpath" : "not(f:kind/@value='instance') or (not(exists(f:implementation)) and not(exists(f:software)))"
},
{
"key" : "cpb-15",
"severity" : "error",
"human" : "If kind = capability, implementation must be absent, software must be present",
"expression" : "(kind != 'capability') or (implementation.exists().not() and software.exists())",
"xpath" : " not(f:kind/@value='instance') or (not(exists(f:implementation)) and exists(f:software))"
},
{
"key" : "cpb-3",
"severity" : "error",
"human" : "Messaging end-point is required (and is only permitted) when a statement is for an implementation.",
"expression" : "messaging.endpoint.empty() or kind = 'instance'",
"xpath" : "not(exists(f:messaging/f:endpoint)) or f:kind/@value = 'instance'"
},
{
"key" : "cpb-14",
"severity" : "error",
"human" : "If kind = instance, implementation must be present and software may be present",
"expression" : "(kind != 'instance') or implementation.exists()",
"xpath" : "not(f:kind/@value='instance') or exists(f:implementation)"
},
{
"key" : "cpb-2",
"severity" : "error",
"human" : "A Capability Statement SHALL have at least one of description, software, or implementation element.",
"expression" : "(description.count() + software.count() + implementation.count()) > 0",
"xpath" : "count(f:software | f:implementation | f:description) > 0"
},
{
"key" : "cpb-1",
"severity" : "error",
"human" : "A Capability Statement SHALL have at least one of REST, messaging or document element.",
"expression" : "rest.exists() or messaging.exists() or document.exists()",
"xpath" : "exists(f:rest) or exists(f:messaging) or exists(f:document)"
},
{
"key" : "cpb-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CapabilityStatement.url",
"path" : "CapabilityStatement.url",
"short" : "Canonical identifier for this capability statement, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this capability statement is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the capability statement to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "CapabilityStatement.version",
"path" : "CapabilityStatement.version",
"short" : "Business version of the capability statement",
"definition" : "The identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different capability statement instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the capability statement with the format [url]|[version].",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "CapabilityStatement.name",
"path" : "CapabilityStatement.name",
"short" : "Name for this capability statement (computer friendly)",
"definition" : "A natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isSummary" : true
},
{
"id" : "CapabilityStatement.title",
"path" : "CapabilityStatement.title",
"short" : "Name for this capability statement (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the capability statement.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "CapabilityStatement.status",
"path" : "CapabilityStatement.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this capability statement. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of capability statements that are appropriate for use versus not.This is not intended for use with actual capability statements, but where capability statements are used to describe possible or desired systems.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "CapabilityStatement.experimental",
"path" : "CapabilityStatement.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of capability statements that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level capability statement.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "CapabilityStatement.date",
"path" : "CapabilityStatement.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the capability statement was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the capability statement. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "CapabilityStatement.publisher",
"path" : "CapabilityStatement.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the capability statement.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the capability statement is the organization or individual primarily responsible for the maintenance and upkeep of the capability statement. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the capability statement. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the capability statement. May also allow for contact.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "CapabilityStatement.contact",
"path" : "CapabilityStatement.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "CapabilityStatement.description",
"path" : "CapabilityStatement.description",
"short" : "Natural language description of the capability statement",
"definition" : "A free text natural language description of the capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.",
"comment" : "This description can be used to capture details such as why the capability statement was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the capability statement as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the capability statement is presumed to be the predominant language in the place the capability statement was created).This does not need to be populated if the description is adequately implied by the software or implementation details.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"condition" : ["cpb-2"],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "CapabilityStatement.useContext",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate capability statement instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "CapabilityStatement.jurisdiction",
"path" : "CapabilityStatement.jurisdiction",
"short" : "Intended jurisdiction for capability statement (if applicable)",
"definition" : "A legal or geographic region in which the capability statement is intended to be used.",
"comment" : "It may be possible for the capability statement to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "CapabilityStatement.purpose",
"path" : "CapabilityStatement.purpose",
"short" : "Why this capability statement is defined",
"definition" : "Explanation of why this capability statement is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the capability statement. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this capability statement.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "CapabilityStatement.copyright",
"path" : "CapabilityStatement.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the capability statement and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "CapabilityStatement.kind",
"path" : "CapabilityStatement.kind",
"short" : "instance | capability | requirements",
"definition" : "The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).",
"requirements" : "Allow searching the 3 modes.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"condition" : ["cpb-15"],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CapabilityStatementKind"
}],
"strength" : "required",
"description" : "How a capability statement is intended to be used.",
"valueSet" : "http://hl7.org/fhir/ValueSet/capability-statement-kind|4.0.0"
}
},
{
"id" : "CapabilityStatement.instantiates",
"path" : "CapabilityStatement.instantiates",
"short" : "Canonical URL of another capability statement this implements",
"definition" : "Reference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details.",
"comment" : "HL7 defines the following Services: [Terminology Service](terminology-service.html). \n\nMany [Implementation Guides](http://fhir.org/guides/registry) define additional services.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CapabilityStatement"]
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement.imports",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.imports",
"short" : "Canonical URL of another capability statement this adds to",
"definition" : "Reference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them.",
"comment" : "the contents of any directly or indirectly imported CapabilityStatements SHALL NOT overlap, i.e. they cannot refer to the same rest/resource, operations/name, searchparam/name, interaction/code, messaging/endpoint, document/mode pair.\n\nA capability statement that imports another CapabilityStatement automatically instantiates it too (though this is often not a very useful statement for the kinds of CapabilityStatements that are suitable for importing).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CapabilityStatement"]
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement.software",
"path" : "CapabilityStatement.software",
"short" : "Software that is covered by this capability statement",
"definition" : "Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["cpb-2"],
"isSummary" : true
},
{
"id" : "CapabilityStatement.software.name",
"path" : "CapabilityStatement.software.name",
"short" : "A name the software is known by",
"definition" : "Name the software is known by.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement.software.version",
"path" : "CapabilityStatement.software.version",
"short" : "Version covered by this statement",
"definition" : "The version identifier for the software covered by this statement.",
"comment" : "If possible, a version should be specified, as statements are likely to be different for different versions of software.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement.software.releaseDate",
"path" : "CapabilityStatement.software.releaseDate",
"short" : "Date this version was released",
"definition" : "Date this version of the software was released.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement.implementation",
"path" : "CapabilityStatement.implementation",
"short" : "If this describes a specific instance",
"definition" : "Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["cpb-2",
"cpb-15"],
"isSummary" : true
},
{
"id" : "CapabilityStatement.implementation.description",
"path" : "CapabilityStatement.implementation.description",
"short" : "Describes this specific instance",
"definition" : "Information about the specific installation that this capability statement relates to.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement.implementation.url",
"path" : "CapabilityStatement.implementation.url",
"short" : "Base URL for the installation",
"definition" : "An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "url"
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement.implementation.custodian",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.implementation.custodian",
"short" : "Organization that manages the data",
"definition" : "The organization responsible for the management of the instance and oversight of the data on the server at the specified URL.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement.fhirVersion",
"path" : "CapabilityStatement.fhirVersion",
"short" : "FHIR Version the system supports",
"definition" : "The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value.",
"comment" : "Servers may implement multiple versions (see [Managing Multiple Versions](versioning.html), and the [$versions](capabilitystatement-operation-versions.html) operation). If they do, and the CapabilityStatement is requested from the server, then this fhirVersion will be either the version requested, or the server's default version.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRVersion"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "All published FHIR Versions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/FHIR-version|4.0.0"
}
},
{
"id" : "CapabilityStatement.format",
"path" : "CapabilityStatement.format",
"short" : "formats supported (xml | json | ttl | mime type)",
"definition" : "A list of the formats supported by this implementation using their content types.",
"comment" : "\"xml\", \"json\" and \"ttl\" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MimeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The mime type of an attachment. Any valid mime type is allowed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|4.0.0"
}
},
{
"id" : "CapabilityStatement.patchFormat",
"path" : "CapabilityStatement.patchFormat",
"short" : "Patch formats supported",
"definition" : "A list of the patch formats supported by this implementation using their content types.",
"comment" : "At present, the patch mime types application/json-patch+json and application/xml-patch+xml are legal. Generally, if a server supports PATCH, it would be expected to support the patch formats and match the formats it supports, but this is not always possible or necessary.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MimeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The mime type of an attachment. Any valid mime type is allowed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|4.0.0"
}
},
{
"id" : "CapabilityStatement.implementationGuide",
"path" : "CapabilityStatement.implementationGuide",
"short" : "Implementation guides supported",
"definition" : "A list of implementation guides that the server does (or should) support in their entirety.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ImplementationGuide"]
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement.rest",
"path" : "CapabilityStatement.rest",
"short" : "If the endpoint is a RESTful one",
"definition" : "A definition of the restful capabilities of the solution, if any.",
"comment" : "Multiple repetitions allow definition of both client and/or server behaviors or possibly behaviors under different configuration settings (for software or requirements statements).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["cpb-1"],
"constraint" : [{
"key" : "cpb-9",
"severity" : "error",
"human" : "A given resource can only be described once per RESTful mode.",
"expression" : "resource.select(type).isDistinct()",
"xpath" : "count(f:resource)=count(distinct-values(f:resource/f:type/@value))"
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement.rest.mode",
"path" : "CapabilityStatement.rest.mode",
"short" : "client | server",
"definition" : "Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RestfulCapabilityMode"
}],
"strength" : "required",
"description" : "The mode of a RESTful capability statement.",
"valueSet" : "http://hl7.org/fhir/ValueSet/restful-capability-mode|4.0.0"
}
},
{
"id" : "CapabilityStatement.rest.documentation",
"path" : "CapabilityStatement.rest.documentation",
"short" : "General description of implementation",
"definition" : "Information about the system's restful capabilities that apply across all applications, such as security.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}]
},
{
"id" : "CapabilityStatement.rest.security",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.rest.security",
"short" : "Information about security of implementation",
"definition" : "Information about security implementation from an interface perspective - what a client needs to know.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement.rest.security.cors",
"path" : "CapabilityStatement.rest.security.cors",
"short" : "Adds CORS Headers (http://enable-cors.org/)",
"definition" : "Server adds CORS headers when responding to requests - this enables Javascript applications to use the server.",
"comment" : "The easiest CORS headers to add are Access-Control-Allow-Origin: * & Access-Control-Request-Method: GET, POST, PUT, DELETE. All servers SHOULD support CORS.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement.rest.security.service",
"path" : "CapabilityStatement.rest.security.service",
"short" : "OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates",
"definition" : "Types of security services that are supported/required by the system.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RestfulSecurityService"
}],
"strength" : "extensible",
"description" : "Types of security services used with FHIR.",
"valueSet" : "http://hl7.org/fhir/ValueSet/restful-security-service"
}
},
{
"id" : "CapabilityStatement.rest.security.description",
"path" : "CapabilityStatement.rest.security.description",
"short" : "General description of how security works",
"definition" : "General description of how security works.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}]
},
{
"id" : "CapabilityStatement.rest.resource",
"path" : "CapabilityStatement.rest.resource",
"short" : "Resource served on the REST interface",
"definition" : "A specification of the restful capabilities of the solution for a specific resource type.",
"comment" : "Max of one repetition per resource type.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "cpb-12",
"severity" : "error",
"human" : "Search parameter names must be unique in the context of a resource.",
"expression" : "searchParam.select(name).isDistinct()",
"xpath" : "count(f:searchParam)=count(distinct-values(f:searchParam/f:name/@value))"
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement.rest.resource.type",
"path" : "CapabilityStatement.rest.resource.type",
"short" : "A resource type that is supported",
"definition" : "A type of resource exposed via the restful interface.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResourceType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "One of the resource types defined as part of this version of FHIR.",
"valueSet" : "http://hl7.org/fhir/ValueSet/resource-types|4.0.0"
}
},
{
"id" : "CapabilityStatement.rest.resource.profile",
"path" : "CapabilityStatement.rest.resource.profile",
"short" : "Base System profile for all uses of resource",
"definition" : "A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles](profiling.html#profile-uses).",
"comment" : "The profile applies to all resources of this type - i.e. it is the superset of what is supported by the system.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement.rest.resource.supportedProfile",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.rest.resource.supportedProfile",
"short" : "Profiles for use cases supported",
"definition" : "A list of profiles that represent different use cases supported by the system. For a server, \"supported by the system\" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses).",
"comment" : "Supported profiles are different than the profile that applies to a particular resource in .rest.resource.profile. The resource profile is a general statement of what features of the resource are supported overall by the system - the sum total of the facilities it supports. A supported profile is a deeper statement about the functionality of the data and services provided by the server (or used by the client). A typical case is a laboratory system that produces a set of different reports - this is the list of types of data that it publishes. A key aspect of declaring profiles here is the question of how the client converts knowledge that the server publishes this data into working with the data; the client can inspect individual resources to determine whether they conform to a particular profile, but how does it find the ones that do? It does so by searching using the _profile parameter, so any resources listed here must be valid values for the _profile resource (using the identifier in the target profile).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement.rest.resource.documentation",
"path" : "CapabilityStatement.rest.resource.documentation",
"short" : "Additional information about the use of the resource type",
"definition" : "Additional information about the resource type used by the system.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}]
},
{
"id" : "CapabilityStatement.rest.resource.interaction",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "ResourceInteraction"
}],
"path" : "CapabilityStatement.rest.resource.interaction",
"short" : "What operations are supported?",
"definition" : "Identifies a restful operation supported by the solution.",
"comment" : "In general, a Resource will only appear in a CapabilityStatement if the server actually has some capabilities - e.g. there is at least one interaction supported. However interactions can be omitted to support summarization (_summary = true).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "CapabilityStatement.rest.resource.interaction.code",
"path" : "CapabilityStatement.rest.resource.interaction.code",
"short" : "read | vread | update | patch | delete | history-instance | history-type | create | search-type",
"definition" : "Coded identifier of the operation, supported by the system resource.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TypeRestfulInteraction"
}],
"strength" : "required",
"description" : "Operations supported by REST at the type or instance level.",
"valueSet" : "http://hl7.org/fhir/ValueSet/type-restful-interaction|4.0.0"
}
},
{
"id" : "CapabilityStatement.rest.resource.interaction.documentation",
"path" : "CapabilityStatement.rest.resource.interaction.documentation",
"short" : "Anything special about operation behavior",
"definition" : "Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'.",
"requirements" : "REST allows a degree of variability in the implementation of RESTful solutions that is useful for exchange partners to be aware of.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}]
},
{
"id" : "CapabilityStatement.rest.resource.versioning",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.rest.resource.versioning",
"short" : "no-version | versioned | versioned-update",
"definition" : "This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API.",
"comment" : "If a server supports versionIds correctly, it SHOULD support vread too, but is not required to do so.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResourceVersionPolicy"
}],
"strength" : "required",
"description" : "How the system supports versioning for a resource.",
"valueSet" : "http://hl7.org/fhir/ValueSet/versioning-policy|4.0.0"
}
},
{
"id" : "CapabilityStatement.rest.resource.readHistory",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.rest.resource.readHistory",
"short" : "Whether vRead can return past versions",
"definition" : "A flag for whether the server is able to return past versions as part of the vRead operation.",
"comment" : "It is useful to support the vRead operation for current operations, even if past versions aren't available.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "CapabilityStatement.rest.resource.updateCreate",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.rest.resource.updateCreate",
"short" : "If update can commit to a new identity",
"definition" : "A flag to indicate that the server allows or needs to allow the client to create new identities on the server (that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server.",
"comment" : "Allowing the clients to create new identities on the server means that the system administrator needs to have confidence that the clients do not create clashing identities between them. Obviously, if there is only one client, this won't happen. While creating identities on the client means that the clients need to be managed, it's much more convenient for many scenarios if such management can be put in place.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "CapabilityStatement.rest.resource.conditionalCreate",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.rest.resource.conditionalCreate",
"short" : "If allows/uses conditional create",
"definition" : "A flag that indicates that the server supports conditional create.",
"comment" : "Conditional Create is mainly appropriate for interface engine scripts converting from other formats, such as v2.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "CapabilityStatement.rest.resource.conditionalRead",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.rest.resource.conditionalRead",
"short" : "not-supported | modified-since | not-match | full-support",
"definition" : "A code that indicates how the server supports conditional read.",
"comment" : "Conditional Read is mainly appropriate for interface engine scripts converting from other formats, such as v2.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConditionalReadStatus"
}],
"strength" : "required",
"description" : "A code that indicates how the server supports conditional read.",
"valueSet" : "http://hl7.org/fhir/ValueSet/conditional-read-status|4.0.0"
}
},
{
"id" : "CapabilityStatement.rest.resource.conditionalUpdate",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.rest.resource.conditionalUpdate",
"short" : "If allows/uses conditional update",
"definition" : "A flag that indicates that the server supports conditional update.",
"comment" : "Conditional Update is mainly appropriate for interface engine scripts converting from other formats, such as v2.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "CapabilityStatement.rest.resource.conditionalDelete",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.rest.resource.conditionalDelete",
"short" : "not-supported | single | multiple - how conditional delete is supported",
"definition" : "A code that indicates how the server supports conditional delete.",
"comment" : "Conditional Delete is mainly appropriate for interface engine scripts converting from other formats, such as v2.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConditionalDeleteStatus"
}],
"strength" : "required",
"description" : "A code that indicates how the server supports conditional delete.",
"valueSet" : "http://hl7.org/fhir/ValueSet/conditional-delete-status|4.0.0"
}
},
{
"id" : "CapabilityStatement.rest.resource.referencePolicy",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.rest.resource.referencePolicy",
"short" : "literal | logical | resolves | enforced | local",
"definition" : "A set of flags that defines how references are supported.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ReferenceHandlingPolicy"
}],
"strength" : "required",
"description" : "A set of flags that defines how references are supported.",
"valueSet" : "http://hl7.org/fhir/ValueSet/reference-handling-policy|4.0.0"
}
},
{
"id" : "CapabilityStatement.rest.resource.searchInclude",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.rest.resource.searchInclude",
"short" : "_include values supported by the server",
"definition" : "A list of _include values supported by the server.",
"comment" : "If this list is empty, the server does not support includes.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "string"
}]
},
{
"id" : "CapabilityStatement.rest.resource.searchRevInclude",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.rest.resource.searchRevInclude",
"short" : "_revinclude values supported by the server",
"definition" : "A list of _revinclude (reverse include) values supported by the server.",
"comment" : "If this list is empty, the server does not support reverse includes.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "string"
}]
},
{
"id" : "CapabilityStatement.rest.resource.searchParam",
"path" : "CapabilityStatement.rest.resource.searchParam",
"short" : "Search parameters supported by implementation",
"definition" : "Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.",
"comment" : "The search parameters should include the control search parameters such as _sort, _count, etc. that also apply to this resource (though many will be listed at [CapabilityStatement.rest.searchParam](capabilitystatement-definitions.html#CapabilityStatement.rest.searchParam)). The behavior of some search parameters may be further described by other code or extension elements, or narrative within the capability statement or linked [SearchParameter](searchparameter.html#) definitions.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "CapabilityStatement.rest.resource.searchParam.name",
"path" : "CapabilityStatement.rest.resource.searchParam.name",
"short" : "Name of search parameter",
"definition" : "The name of the search parameter used in the interface.",
"comment" : "Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "CapabilityStatement.rest.resource.searchParam.definition",
"path" : "CapabilityStatement.rest.resource.searchParam.definition",
"short" : "Source of definition for parameter",
"definition" : "An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [SearchParameter.url](searchparameter-definitions.html#SearchParameter.url)). This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.",
"comment" : "This SHOULD be present, and matches refers to a SearchParameter by its canonical URL. If systems wish to document their support for modifiers, comparators, target resource types, and chained parameters, they should do using a search parameter resource. This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SearchParameter"]
}]
},
{
"id" : "CapabilityStatement.rest.resource.searchParam.type",
"path" : "CapabilityStatement.rest.resource.searchParam.type",
"short" : "number | date | string | token | reference | composite | quantity | uri | special",
"definition" : "The type of value a search parameter refers to, and how the content is interpreted.",
"comment" : "While this can be looked up from the definition, it is included here as a convenience for systems that autogenerate a query interface based on the server capability statement. It SHALL be the same as the type in the search parameter definition.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SearchParamType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "Data types allowed to be used for search parameters.",
"valueSet" : "http://hl7.org/fhir/ValueSet/search-param-type|4.0.0"
}
},
{
"id" : "CapabilityStatement.rest.resource.searchParam.documentation",
"path" : "CapabilityStatement.rest.resource.searchParam.documentation",
"short" : "Server-specific usage",
"definition" : "This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}]
},
{
"id" : "CapabilityStatement.rest.resource.operation",
"path" : "CapabilityStatement.rest.resource.operation",
"short" : "Definition of a resource operation",
"definition" : "Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters.",
"comment" : "Operations linked from CapabilityStatement.rest.resource.operation must have OperationDefinition.type = true or OperationDefinition.instance = true. \n\nIf an operation that is listed in multiple CapabilityStatement.rest.resource.operation (e.g. for different resource types), then clients should understand that the operation is only supported on the specified resource types, and that may be a subset of those listed in OperationDefinition.resource.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement.rest.resource.operation.name",
"path" : "CapabilityStatement.rest.resource.operation.name",
"short" : "Name by which the operation/query is invoked",
"definition" : "The name of the operation or query. For an operation, this is the name prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called.",
"comment" : "The name here SHOULD be the same as the name in the definition, unless there is a name clash and the name cannot be used. The name does not include the \"$\" portion that is always included in the URL.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement.rest.resource.operation.definition",
"path" : "CapabilityStatement.rest.resource.operation.definition",
"short" : "The defined operation/query",
"definition" : "Where the formal definition can be found. If a server references the base definition of an Operation (i.e. from the specification itself such as ```http://hl7.org/fhir/OperationDefinition/ValueSet-expand```), that means it supports the full capabilities of the operation - e.g. both GET and POST invocation. If it only supports a subset, it must define its own custom [OperationDefinition](operationdefinition.html#) with a 'base' of the original OperationDefinition. The custom definition would describe the specific subset of functionality supported.",
"comment" : "This can be used to build an HTML form to invoke the operation, for instance.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/OperationDefinition"]
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement.rest.resource.operation.documentation",
"path" : "CapabilityStatement.rest.resource.operation.documentation",
"short" : "Specific details about operation behavior",
"definition" : "Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}]
},
{
"id" : "CapabilityStatement.rest.interaction",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "SystemInteraction"
}],
"path" : "CapabilityStatement.rest.interaction",
"short" : "What operations are supported?",
"definition" : "A specification of restful operations supported by the system.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "CapabilityStatement.rest.interaction.code",
"path" : "CapabilityStatement.rest.interaction.code",
"short" : "transaction | batch | search-system | history-system",
"definition" : "A coded identifier of the operation, supported by the system.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SystemRestfulInteraction"
}],
"strength" : "required",
"description" : "Operations supported by REST at the system level.",
"valueSet" : "http://hl7.org/fhir/ValueSet/system-restful-interaction|4.0.0"
}
},
{
"id" : "CapabilityStatement.rest.interaction.documentation",
"path" : "CapabilityStatement.rest.interaction.documentation",
"short" : "Anything special about operation behavior",
"definition" : "Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}]
},
{
"id" : "CapabilityStatement.rest.searchParam",
"path" : "CapabilityStatement.rest.searchParam",
"short" : "Search parameters for searching all resources",
"definition" : "Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.",
"comment" : "Typically, the only search parameters supported for all searches are those that apply to all resources - tags, profiles, text search etc. These search parameters should include the control search parameters such as _sort, _count, etc. that also apply to this resource (though many will be listed at [CapabilityStatement.rest.searchParam](capabilitystatement-definitions.html#CapabilityStatement.rest.searchParam)). The behavior of some search parameters may be further described by other code or extension elements, or narrative within the capability statement or linked [SearchParameter](searchparameter.html#) definitions.",
"min" : 0,
"max" : "*",
"contentReference" : "#CapabilityStatement.rest.resource.searchParam"
},
{
"id" : "CapabilityStatement.rest.operation",
"path" : "CapabilityStatement.rest.operation",
"short" : "Definition of a system level operation",
"definition" : "Definition of an operation or a named query together with its parameters and their meaning and type.",
"comment" : "CapabilityStatement.rest.operation is for operations invoked at the system level, or for operations that are supported across multiple resource types. Operations linked from CapabilityStatement.rest.operation must have OperationDefinition.system = true, or more than one Operation.resource.",
"min" : 0,
"max" : "*",
"contentReference" : "#CapabilityStatement.rest.resource.operation",
"isSummary" : true
},
{
"id" : "CapabilityStatement.rest.compartment",
"path" : "CapabilityStatement.rest.compartment",
"short" : "Compartments served/used by system",
"definition" : "An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL .",
"comment" : "At present, the only defined compartments are at [CompartmentDefinition](compartmentdefinition.html).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CompartmentDefinition"]
}]
},
{
"id" : "CapabilityStatement.messaging",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.messaging",
"short" : "If messaging is supported",
"definition" : "A description of the messaging capabilities of the solution.",
"comment" : "Multiple repetitions allow the documentation of multiple endpoints per solution.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["cpb-1"],
"isSummary" : true
},
{
"id" : "CapabilityStatement.messaging.endpoint",
"path" : "CapabilityStatement.messaging.endpoint",
"short" : "Where messages should be sent",
"definition" : "An endpoint (network accessible address) to which messages and/or replies are to be sent.",
"alias" : ["3"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "CapabilityStatement.messaging.endpoint.protocol",
"path" : "CapabilityStatement.messaging.endpoint.protocol",
"short" : "http | ftp | mllp +",
"definition" : "A list of the messaging transport protocol(s) identifiers, supported by this endpoint.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Coding"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MessageTransport"
}],
"strength" : "extensible",
"description" : "The protocol used for message transport.",
"valueSet" : "http://hl7.org/fhir/ValueSet/message-transport"
}
},
{
"id" : "CapabilityStatement.messaging.endpoint.address",
"path" : "CapabilityStatement.messaging.endpoint.address",
"short" : "Network address or identifier of the end-point",
"definition" : "The network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifier.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "url"
}]
},
{
"id" : "CapabilityStatement.messaging.reliableCache",
"path" : "CapabilityStatement.messaging.reliableCache",
"short" : "Reliable Message Cache Length (min)",
"definition" : "Length if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender).",
"comment" : "If this value is missing then the application does not implement (receiver) or depend on (sender) reliable messaging.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "unsignedInt"
}]
},
{
"id" : "CapabilityStatement.messaging.documentation",
"path" : "CapabilityStatement.messaging.documentation",
"short" : "Messaging interface behavior details",
"definition" : "Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, the process for becoming an authorized messaging exchange partner.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}]
},
{
"id" : "CapabilityStatement.messaging.supportedMessage",
"path" : "CapabilityStatement.messaging.supportedMessage",
"short" : "Messages supported by this system",
"definition" : "References to message definitions for messages this system can send or receive.",
"comment" : "This is a proposed alternative to the messaging.event structure.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement.messaging.supportedMessage.mode",
"path" : "CapabilityStatement.messaging.supportedMessage.mode",
"short" : "sender | receiver",
"definition" : "The mode of this event declaration - whether application is sender or receiver.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "EventCapabilityMode"
}],
"strength" : "required",
"description" : "The mode of a message capability statement.",
"valueSet" : "http://hl7.org/fhir/ValueSet/event-capability-mode|4.0.0"
}
},
{
"id" : "CapabilityStatement.messaging.supportedMessage.definition",
"path" : "CapabilityStatement.messaging.supportedMessage.definition",
"short" : "Message supported by this system",
"definition" : "Points to a message definition that identifies the messaging event, message structure, allowed responses, etc.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MessageDefinition"]
}],
"isSummary" : true
},
{
"id" : "CapabilityStatement.document",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CapabilityStatement.document",
"short" : "Document definition",
"definition" : "A document definition.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["cpb-1"],
"isSummary" : true
},
{
"id" : "CapabilityStatement.document.mode",
"path" : "CapabilityStatement.document.mode",
"short" : "producer | consumer",
"definition" : "Mode of this document declaration - whether an application is a producer or consumer.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DocumentMode"
}],
"strength" : "required",
"description" : "Whether the application produces or consumes documents.",
"valueSet" : "http://hl7.org/fhir/ValueSet/document-mode|4.0.0"
}
},
{
"id" : "CapabilityStatement.document.documentation",
"path" : "CapabilityStatement.document.documentation",
"short" : "Description of document support",
"definition" : "A description of how the application supports or uses the specified document profile. For example, when documents are created, what action is taken with consumed documents, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}]
},
{
"id" : "CapabilityStatement.document.profile",
"path" : "CapabilityStatement.document.profile",
"short" : "Constraint on the resources used in the document",
"definition" : "A profile on the document Bundle that constrains which resources are present, and their contents.",
"comment" : "The profile is actually on the Bundle.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"isSummary" : true
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/CarePlan",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "CarePlan",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints CarePlan TU DomainResource Healthcare plan for patient or group
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension \r\n identifier Σ 0..* Identifier External Ids for this plan
\r\n instantiatesCanonical Σ 0..* canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) Instantiates FHIR protocol or definition
\r\n instantiatesUri Σ 0..* uri Instantiates external protocol or definition
\r\n basedOn Σ 0..* Reference(CarePlan) Fulfills CarePlan
\r\n replaces Σ 0..* Reference(CarePlan) CarePlan replaced by this CarePlan
\r\n partOf Σ 0..* Reference(CarePlan) Part of referenced CarePlan
\r\n status ?!Σ 1..1 code draft | active | suspended | completed | entered-in-error | cancelled | unknown
RequestStatus (Required) \r\n intent ?!Σ 1..1 code proposal | plan | order | option
Care Plan Intent (Required) \r\n category Σ 0..* CodeableConcept Type of plan
Care Plan Category (Example)
\r\n title Σ 0..1 string Human-friendly name for the care plan \r\n description Σ 0..1 string Summary of nature of plan \r\n subject Σ 1..1 Reference(Patient | Group) Who the care plan is for \r\n encounter Σ 0..1 Reference(Encounter) Encounter created as part of \r\n period Σ 0..1 Period Time period plan covers \r\n created Σ 0..1 dateTime Date record was first recorded \r\n author Σ 0..1 Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who is the designated responsible party \r\n contributor 0..* Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who provided the content of the care plan
\r\n careTeam 0..* Reference(CareTeam) Who's involved in plan?
\r\n addresses Σ 0..* Reference(Condition) Health issues this plan addresses
\r\n supportingInfo 0..* Reference(Any) Information considered as part of plan
\r\n goal 0..* Reference(Goal) Desired outcome of plan
\r\n activity I 0..* BackboneElement Action to occur as part of plan
+ Rule: Provide a reference or detail, not both
\r\n outcomeCodeableConcept 0..* CodeableConcept Results of the activity
Care Plan Activity Outcome (Example)
\r\n outcomeReference 0..* Reference(Any) Appointment, Encounter, Procedure, etc.
\r\n progress 0..* Annotation Comments about the activity status/progress
\r\n reference I 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource \r\n detail I 0..1 BackboneElement In-line definition of activity \r\n kind 0..1 code Kind of resource
Care Plan Activity Kind (Required) \r\n instantiatesCanonical 0..* canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) Instantiates FHIR protocol or definition
\r\n instantiatesUri 0..* uri Instantiates external protocol or definition
\r\n code 0..1 CodeableConcept Detail type of activity
Procedure Codes (SNOMED CT) (Example) \r\n reasonCode 0..* CodeableConcept Why activity should be done or why activity was prohibited
SNOMED CT Clinical Findings (Example)
\r\n reasonReference 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why activity is needed
\r\n goal 0..* Reference(Goal) Goals this activity relates to
\r\n status ?! 1..1 code not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
CarePlanActivityStatus (Required) \r\n statusReason 0..1 CodeableConcept Reason for current status \r\n doNotPerform ?! 0..1 boolean If true, activity is prohibiting action \r\n scheduled[x] 0..1 When activity is to occur \r\n scheduledTiming Timing \r\n scheduledPeriod Period \r\n scheduledString string \r\n location 0..1 Reference(Location) Where it should happen \r\n performer 0..* Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) Who will be responsible?
\r\n product[x] 0..1 What is to be administered/supplied
SNOMED CT Medication Codes (Example) \r\n productCodeableConcept CodeableConcept \r\n productReference Reference(Medication | Substance) \r\n dailyAmount 0..1 SimpleQuantity How to consume/day? \r\n quantity 0..1 SimpleQuantity How much to administer/supply/consume \r\n description 0..1 string Extra info describing activity to perform \r\n note 0..* Annotation Comments about the plan
\r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Care Provision"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pc"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/CarePlan",
"version" : "4.0.0",
"name" : "CarePlan",
"status" : "draft",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (Patient Care)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}]
}],
"description" : "Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "CarePlan",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "CarePlan",
"path" : "CarePlan",
"short" : "Healthcare plan for patient or group",
"definition" : "Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.",
"alias" : ["Care Team"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "CarePlan",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Request"
},
{
"identity" : "rim",
"map" : "Act[classCode=PCPR, moodCode=INT]"
}]
},
{
"id" : "CarePlan.id",
"path" : "CarePlan.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CarePlan.meta",
"path" : "CarePlan.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CarePlan.implicitRules",
"path" : "CarePlan.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "CarePlan.language",
"path" : "CarePlan.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "CarePlan.text",
"path" : "CarePlan.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "CarePlan.contained",
"path" : "CarePlan.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CarePlan.extension",
"path" : "CarePlan.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CarePlan.modifierExtension",
"path" : "CarePlan.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CarePlan.identifier",
"path" : "CarePlan.identifier",
"short" : "External Ids for this plan",
"definition" : "Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server.",
"comment" : "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"requirements" : "Allows identification of the care plan as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CarePlan.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "PTH-3"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "CarePlan.instantiatesCanonical",
"path" : "CarePlan.instantiatesCanonical",
"short" : "Instantiates FHIR protocol or definition",
"definition" : "The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CarePlan.instantiatesCanonical",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"http://hl7.org/fhir/StructureDefinition/Questionnaire",
"http://hl7.org/fhir/StructureDefinition/Measure",
"http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"http://hl7.org/fhir/StructureDefinition/OperationDefinition"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiatesCanonical"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "CarePlan.instantiatesUri",
"path" : "CarePlan.instantiatesUri",
"short" : "Instantiates external protocol or definition",
"definition" : "The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.",
"comment" : "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CarePlan.instantiatesUri",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiatesUri"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "CarePlan.basedOn",
"path" : "CarePlan.basedOn",
"short" : "Fulfills CarePlan",
"definition" : "A care plan that is fulfilled in whole or in part by this care plan.",
"requirements" : "Allows tracing of the care plan and tracking whether proposals/recommendations were acted upon.",
"alias" : ["fulfills"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "CarePlan.basedOn",
"min" : 0,
"max" : "*"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean" : true
}],
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.basedOn"
}]
},
{
"id" : "CarePlan.replaces",
"path" : "CarePlan.replaces",
"short" : "CarePlan replaced by this CarePlan",
"definition" : "Completed or terminated care plan whose function is taken by this new care plan.",
"comment" : "The replacement could be because the initial care plan was immediately rejected (due to an issue) or because the previous care plan was completed, but the need for the action described by the care plan remains ongoing.",
"requirements" : "Allows tracing the continuation of a therapy or administrative process instantiated through multiple care plans.",
"alias" : ["supersedes"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "CarePlan.replaces",
"min" : 0,
"max" : "*"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean" : true
}],
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.replaces"
}]
},
{
"id" : "CarePlan.partOf",
"path" : "CarePlan.partOf",
"short" : "Part of referenced CarePlan",
"definition" : "A larger care plan of which this particular care plan is a component or step.",
"comment" : "Each care plan is an independent request, such that having a care plan be part of another care plan can cause issues with cascading statuses. As such, this element is still being discussed.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CarePlan.partOf",
"min" : 0,
"max" : "*"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean" : true
}],
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan"]
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CarePlan.status",
"path" : "CarePlan.status",
"short" : "draft | active | suspended | completed | entered-in-error | cancelled | unknown",
"definition" : "Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.",
"comment" : "The unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the care plan.\n\nThis element is labeled as a modifier because the status contains the code entered-in-error that marks the plan as not currently valid.",
"requirements" : "Allows clinicians to determine whether the plan is actionable or not.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CarePlan.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CarePlanStatus"
}],
"strength" : "required",
"description" : "Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status {uses different ValueSet}"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "PTH-5"
},
{
"identity" : "rim",
"map" : ".statusCode planned = new active = active completed = completed"
}]
},
{
"id" : "CarePlan.intent",
"path" : "CarePlan.intent",
"short" : "proposal | plan | order | option",
"definition" : "Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.",
"comment" : "This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.",
"requirements" : "Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CarePlan.intent",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element changes the interpretation of all descriptive attributes. For example \"the time the request is recommended to occur\" vs. \"the time the request is authorized to occur\" or \"who is recommended to perform the request\" vs. \"who is authorized to perform the request\"",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CarePlanIntent"
}],
"strength" : "required",
"description" : "Codes indicating the degree of authority/intentionality associated with a care plan.",
"valueSet" : "http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.intent"
}]
},
{
"id" : "CarePlan.category",
"path" : "CarePlan.category",
"short" : "Type of plan",
"definition" : "Identifies what \"kind\" of plan this is to support differentiation between multiple co-existing plans; e.g. \"Home health\", \"psychiatric\", \"asthma\", \"disease management\", \"wellness plan\", etc.",
"comment" : "There may be multiple axes of categorization and one plan may serve multiple purposes. In some cases, this may be redundant with references to CarePlan.concern.",
"requirements" : "Used for filtering what plan(s) are retrieved and displayed to different types of users.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CarePlan.category",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CarePlanCategory"
}],
"strength" : "example",
"description" : "Identifies what \"kind\" of plan this is to support differentiation between multiple co-existing plans; e.g. \"Home health\", \"psychiatric\", \"asthma\", \"disease management\", etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/care-plan-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "CarePlan.title",
"path" : "CarePlan.title",
"short" : "Human-friendly name for the care plan",
"definition" : "Human-friendly name for the care plan.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CarePlan.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CarePlan.description",
"path" : "CarePlan.description",
"short" : "Summary of nature of plan",
"definition" : "A description of the scope and nature of the plan.",
"requirements" : "Provides more detail than conveyed by category.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CarePlan.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
}]
},
{
"id" : "CarePlan.subject",
"path" : "CarePlan.subject",
"short" : "Who the care plan is for",
"definition" : "Identifies the patient or group whose intended care is described by the plan.",
"alias" : ["patient"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "CarePlan.subject",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PID-3"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PAT].role[classCode=PAT]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "CarePlan.encounter",
"path" : "CarePlan.encounter",
"short" : "Encounter created as part of",
"definition" : "The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.",
"comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. CarePlan activities conducted as a result of the care plan may well occur as part of other encounters.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CarePlan.encounter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.context"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "v2",
"map" : "Associated PV1"
},
{
"identity" : "rim",
"map" : "."
}]
},
{
"id" : "CarePlan.period",
"path" : "CarePlan.period",
"short" : "Time period plan covers",
"definition" : "Indicates when the plan did (or is intended to) come into effect and end.",
"comment" : "Any activities scheduled as part of the plan should be constrained to the specified period regardless of whether the activities are planned within a single encounter/episode or across multiple encounters/episodes (e.g. the longitudinal management of a chronic condition).",
"requirements" : "Allows tracking what plan(s) are in effect at a particular time.",
"alias" : ["timing"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "CarePlan.period",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.planned"
},
{
"identity" : "v2",
"map" : "GOL-7 / GOL-8"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "CarePlan.created",
"path" : "CarePlan.created",
"short" : "Date record was first recorded",
"definition" : "Represents when this particular CarePlan record was created in the system, which is often a system-generated date.",
"alias" : ["authoredOn"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "CarePlan.created",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.authoredOn"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].time"
}]
},
{
"id" : "CarePlan.author",
"path" : "CarePlan.author",
"short" : "Who is the designated responsible party",
"definition" : "When populated, the author is responsible for the care plan. The care plan is attributed to the author.",
"comment" : "The author may also be a contributor. For example, an organization can be an author, but not listed as a contributor.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CarePlan.author",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/CareTeam"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.requester"
},
{
"identity" : "w5",
"map" : "FiveWs.author"
}]
},
{
"id" : "CarePlan.contributor",
"path" : "CarePlan.contributor",
"short" : "Who provided the content of the care plan",
"definition" : "Identifies the individual(s) or organization who provided the contents of the care plan.",
"comment" : "Collaborative care plans may have multiple contributors.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CarePlan.contributor",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/CareTeam"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CarePlan.careTeam",
"path" : "CarePlan.careTeam",
"short" : "Who's involved in plan?",
"definition" : "Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.",
"requirements" : "Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CarePlan.careTeam",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CareTeam"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performer {similar but does not entail CareTeam}"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
}]
},
{
"id" : "CarePlan.addresses",
"path" : "CarePlan.addresses",
"short" : "Health issues this plan addresses",
"definition" : "Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.",
"comment" : "When the diagnosis is related to an allergy or intolerance, the Condition and AllergyIntolerance resources can both be used. However, to be actionable for decision support, using Condition alone is not sufficient as the allergy or intolerance condition needs to be represented as an AllergyIntolerance.",
"requirements" : "Links plan to the conditions it manages. The element can identify risks addressed by the plan as well as active conditions. (The Condition resource can include things like \"at risk for hypertension\" or \"fall risk\".) Also scopes plans - multiple plans may exist addressing different concerns.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CarePlan.addresses",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonReference"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "v2",
"map" : "PRB-4"
},
{
"identity" : "rim",
"map" : ".actRelationship[typeCode=SUBJ].target[classCode=CONC, moodCode=EVN]"
}]
},
{
"id" : "CarePlan.supportingInfo",
"path" : "CarePlan.supportingInfo",
"short" : "Information considered as part of plan",
"definition" : "Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.",
"comment" : "Use \"concern\" to identify specific conditions addressed by the care plan.",
"requirements" : "Identifies barriers and other considerations associated with the care plan.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CarePlan.supportingInfo",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.supportingInfo"
}]
},
{
"id" : "CarePlan.goal",
"path" : "CarePlan.goal",
"short" : "Desired outcome of plan",
"definition" : "Describes the intended objective(s) of carrying out the care plan.",
"comment" : "Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.",
"requirements" : "Provides context for plan. Allows plan effectiveness to be evaluated by clinicians.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CarePlan.goal",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Goal"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "GOL.1"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode<=OBJ]."
}]
},
{
"id" : "CarePlan.activity",
"path" : "CarePlan.activity",
"short" : "Action to occur as part of plan",
"definition" : "Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.",
"requirements" : "Allows systems to prompt for performance of planned activities, and validate plans against best practice.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CarePlan.activity",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "cpl-3",
"severity" : "error",
"human" : "Provide a reference or detail, not both",
"expression" : "detail.empty() or reference.empty()",
"xpath" : "not(exists(f:detail)) or not(exists(f:reference))"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "{no mapping\nNOTE: This is a list of contained Request-Event tuples!}"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target"
}]
},
{
"id" : "CarePlan.activity.id",
"path" : "CarePlan.activity.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CarePlan.activity.extension",
"path" : "CarePlan.activity.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CarePlan.activity.modifierExtension",
"path" : "CarePlan.activity.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CarePlan.activity.outcomeCodeableConcept",
"path" : "CarePlan.activity.outcomeCodeableConcept",
"short" : "Results of the activity",
"definition" : "Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).",
"comment" : "Note that this should not duplicate the activity status (e.g. completed or in progress).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CarePlan.activity.outcomeCodeableConcept",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CarePlanActivityOutcome"
}],
"strength" : "example",
"description" : "Identifies the results of the activity.",
"valueSet" : "http://hl7.org/fhir/ValueSet/care-plan-activity-outcome"
}
},
{
"id" : "CarePlan.activity.outcomeReference",
"path" : "CarePlan.activity.outcomeReference",
"short" : "Appointment, Encounter, Procedure, etc.",
"definition" : "Details of the outcome or action resulting from the activity. The reference to an \"event\" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource).",
"comment" : "The activity outcome is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lbs and an activity is defined to diet, then the activity outcome could be calories consumed whereas the goal outcome is an observation for the actual body weight measured.",
"requirements" : "Links plan to resulting actions.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CarePlan.activity.outcomeReference",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "{Event that is outcome of Request in activity.reference}"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=FLFS].source"
}]
},
{
"id" : "CarePlan.activity.progress",
"path" : "CarePlan.activity.progress",
"short" : "Comments about the activity status/progress",
"definition" : "Notes about the adherence/status/progress of the activity.",
"comment" : "This element should NOT be used to describe the activity to be performed - that occurs either within the resource pointed to by activity.detail.reference or in activity.detail.description.",
"requirements" : "Can be used to capture information about adherence, progress, concerns, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CarePlan.activity.progress",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "NTE?"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}]
},
{
"id" : "CarePlan.activity.reference",
"path" : "CarePlan.activity.reference",
"short" : "Activity details defined in specific resource",
"definition" : "The details of the proposed activity represented in a specific resource.",
"comment" : "Standard extension exists ([resource-pertainsToGoal](extension-resource-pertainstogoal.html)) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.reference. \rThe goal should be visible when the resource referenced by CarePlan.activity.reference is viewed independently from the CarePlan. Requests that are pointed to by a CarePlan using this element should *not* point to this CarePlan using the \"basedOn\" element. i.e. Requests that are part of a CarePlan are not \"based on\" the CarePlan.",
"requirements" : "Details in a form consistent with other applications and contexts of use.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CarePlan.activity.reference",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Appointment",
"http://hl7.org/fhir/StructureDefinition/CommunicationRequest",
"http://hl7.org/fhir/StructureDefinition/DeviceRequest",
"http://hl7.org/fhir/StructureDefinition/MedicationRequest",
"http://hl7.org/fhir/StructureDefinition/NutritionOrder",
"http://hl7.org/fhir/StructureDefinition/Task",
"http://hl7.org/fhir/StructureDefinition/ServiceRequest",
"http://hl7.org/fhir/StructureDefinition/VisionPrescription",
"http://hl7.org/fhir/StructureDefinition/RequestGroup"]
}],
"condition" : ["cpl-3"],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "{Request that resulted in Event in activity.actionResulting}"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target"
}]
},
{
"id" : "CarePlan.activity.detail",
"path" : "CarePlan.activity.detail",
"short" : "In-line definition of activity",
"definition" : "A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.",
"requirements" : "Details in a simple form for generic care plan systems.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CarePlan.activity.detail",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["cpl-3"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target"
}]
},
{
"id" : "CarePlan.activity.detail.id",
"path" : "CarePlan.activity.detail.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CarePlan.activity.detail.extension",
"path" : "CarePlan.activity.detail.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CarePlan.activity.detail.modifierExtension",
"path" : "CarePlan.activity.detail.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CarePlan.activity.detail.kind",
"path" : "CarePlan.activity.detail.kind",
"short" : "Kind of resource",
"definition" : "A description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.",
"requirements" : "May determine what types of extensions are permitted.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CarePlan.activity.detail.kind",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CarePlanActivityKind"
}],
"strength" : "required",
"description" : "Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.",
"valueSet" : "http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.0"
},
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=LIST].code"
}]
},
{
"id" : "CarePlan.activity.detail.instantiatesCanonical",
"path" : "CarePlan.activity.detail.instantiatesCanonical",
"short" : "Instantiates FHIR protocol or definition",
"definition" : "The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.",
"requirements" : "Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CarePlan.activity.detail.instantiatesCanonical",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"http://hl7.org/fhir/StructureDefinition/Questionnaire",
"http://hl7.org/fhir/StructureDefinition/Measure",
"http://hl7.org/fhir/StructureDefinition/OperationDefinition"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiatesCanonical"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "CarePlan.activity.detail.instantiatesUri",
"path" : "CarePlan.activity.detail.instantiatesUri",
"short" : "Instantiates external protocol or definition",
"definition" : "The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.",
"comment" : "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.",
"requirements" : "Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CarePlan.activity.detail.instantiatesUri",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiatesUri"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "CarePlan.activity.detail.code",
"path" : "CarePlan.activity.detail.code",
"short" : "Detail type of activity",
"definition" : "Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter.",
"comment" : "Tends to be less relevant for activities involving particular products. Codes should not convey negation - use \"prohibited\" instead.",
"requirements" : "Allows matching performed to planned as well as validation against protocols.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CarePlan.activity.detail.code",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CarePlanActivityType"
}],
"strength" : "example",
"description" : "Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.",
"valueSet" : "http://hl7.org/fhir/ValueSet/procedure-code"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "v2",
"map" : "OBR-4 / RXE-2 / RXO-1 / RXD-2"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "CarePlan.activity.detail.reasonCode",
"path" : "CarePlan.activity.detail.reasonCode",
"short" : "Why activity should be done or why activity was prohibited",
"definition" : "Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.",
"comment" : "This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CarePlan.activity.detail.reasonCode",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CarePlanActivityReason"
}],
"strength" : "example",
"description" : "Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as \"general wellness\", prophylaxis, surgical preparation, etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/clinical-findings"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonCode"
}]
},
{
"id" : "CarePlan.activity.detail.reasonReference",
"path" : "CarePlan.activity.detail.reasonReference",
"short" : "Why activity is needed",
"definition" : "Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan.",
"comment" : "Conditions can be identified at the activity level that are not identified as reasons for the overall plan.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CarePlan.activity.detail.reasonReference",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonReference"
}]
},
{
"id" : "CarePlan.activity.detail.goal",
"path" : "CarePlan.activity.detail.goal",
"short" : "Goals this activity relates to",
"definition" : "Internal reference that identifies the goals that this activity is intended to contribute towards meeting.",
"requirements" : "So that participants know the link explicitly.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CarePlan.activity.detail.goal",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Goal"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode<=OBJ]."
}]
},
{
"id" : "CarePlan.activity.detail.status",
"path" : "CarePlan.activity.detail.status",
"short" : "not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error",
"definition" : "Identifies what progress is being made for the specific activity.",
"comment" : "Some aspects of status can be inferred based on the resources linked in actionTaken. Note that \"status\" is only as current as the plan was most recently updated. \nThe unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the activity.",
"requirements" : "Indicates progress against the plan, whether the activity is still relevant for the plan.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CarePlan.activity.detail.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the activity should not be treated as valid",
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CarePlanActivityStatus"
}],
"strength" : "required",
"description" : "Codes that reflect the current state of a care plan activity within its overall life cycle.",
"valueSet" : "http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status"
},
{
"identity" : "v2",
"map" : "ORC-5?"
},
{
"identity" : "rim",
"map" : ".statusCode not-started = new scheduled = not-started (and fulfillment relationship to appointent) in-progress = active on-hold = suspended completed = completed cancelled = aborted"
}]
},
{
"id" : "CarePlan.activity.detail.statusReason",
"path" : "CarePlan.activity.detail.statusReason",
"short" : "Reason for current status",
"definition" : "Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.",
"comment" : "Will generally not be present if status is \"complete\". Be sure to prompt to update this (or at least remove the existing value) if the status is changed.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CarePlan.activity.detail.statusReason",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.statusReason"
}]
},
{
"id" : "CarePlan.activity.detail.doNotPerform",
"path" : "CarePlan.activity.detail.doNotPerform",
"short" : "If true, activity is prohibiting action",
"definition" : "If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan.",
"comment" : "This element is labeled as a modifier because it marks an activity as an activity that is not to be performed.",
"requirements" : "Captures intention to not do something that may have been previously typical.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CarePlan.activity.detail.doNotPerform",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "If missing indicates that the described activity is one that should be engaged in when following the plan.",
"isModifier" : true,
"isModifierReason" : "If true this element negates the specified action. For example, instead of a request for a procedure, it is a request for the procedure to not occur.",
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.doNotPerform"
},
{
"identity" : "rim",
"map" : "actionNegationInd"
}]
},
{
"id" : "CarePlan.activity.detail.scheduled[x]",
"path" : "CarePlan.activity.detail.scheduled[x]",
"short" : "When activity is to occur",
"definition" : "The period, timing or frequency upon which the described activity is to occur.",
"requirements" : "Allows prompting for activities and detection of missed planned activities.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CarePlan.activity.detail.scheduled[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Timing"
},
{
"code" : "Period"
},
{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "v2",
"map" : "TQ1"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "CarePlan.activity.detail.location",
"path" : "CarePlan.activity.detail.location",
"short" : "Where it should happen",
"definition" : "Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.",
"comment" : "May reference a specific clinical location or may identify a type of location.",
"requirements" : "Helps in planning of activity.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CarePlan.activity.detail.location",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OBR-24(???!!)"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=LOC].role"
}]
},
{
"id" : "CarePlan.activity.detail.performer",
"path" : "CarePlan.activity.detail.performer",
"short" : "Who will be responsible?",
"definition" : "Identifies who's expected to be involved in the activity.",
"comment" : "A performer MAY also be a participant in the care plan.",
"requirements" : "Helps in planning of activity.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CarePlan.activity.detail.performer",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/CareTeam",
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performer"
},
{
"identity" : "v2",
"map" : "PRT-5 : ( PRV-4 = (provider participations)); PRT-5 : ( PRV-4 = (non-provider person participations )) ; PRT-5 : ( PRV-4 = (patient non-subject of care) ) ; PRT-8"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PFM]"
}]
},
{
"id" : "CarePlan.activity.detail.product[x]",
"path" : "CarePlan.activity.detail.product[x]",
"short" : "What is to be administered/supplied",
"definition" : "Identifies the food, drug or other product to be consumed or supplied in the activity.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CarePlan.activity.detail.product[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Substance"]
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CarePlanProduct"
}],
"strength" : "example",
"description" : "A product supplied or administered as part of a care plan activity.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-codes"
},
"mapping" : [{
"identity" : "v2",
"map" : "RXE-2 / RXO-1 / RXD-2"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRD].role"
}]
},
{
"id" : "CarePlan.activity.detail.dailyAmount",
"path" : "CarePlan.activity.detail.dailyAmount",
"short" : "How to consume/day?",
"definition" : "Identifies the quantity expected to be consumed in a given day.",
"requirements" : "Allows rough dose checking.",
"alias" : ["daily dose"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "CarePlan.activity.detail.dailyAmount",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "RXO-23 / RXE-19 / RXD-12"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP][classCode=SBADM].doseQuantity"
}]
},
{
"id" : "CarePlan.activity.detail.quantity",
"path" : "CarePlan.activity.detail.quantity",
"short" : "How much to administer/supply/consume",
"definition" : "Identifies the quantity expected to be supplied, administered or consumed by the subject.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CarePlan.activity.detail.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "RXO-11 / RXE-10 / RXD-4 / RXG-5 / RXA-6 / TQ1-2.1 *and* RXO-12 / RXE-11 / RXD-5 / RXG-7 / RXA-7 / TQ1-2.2"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP][classCode=SPLY].quantity"
}]
},
{
"id" : "CarePlan.activity.detail.description",
"path" : "CarePlan.activity.detail.description",
"short" : "Extra info describing activity to perform",
"definition" : "This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CarePlan.activity.detail.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "NTE?"
},
{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "CarePlan.note",
"path" : "CarePlan.note",
"short" : "Comments about the plan",
"definition" : "General notes about the care plan not covered elsewhere.",
"requirements" : "Used to capture information that applies to the plan as a whole that doesn't fit into discrete elements.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CarePlan.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.note"
},
{
"identity" : "v2",
"map" : "NTE?"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}]
}]
},
"differential" : {
"element" : [{
"id" : "CarePlan",
"path" : "CarePlan",
"short" : "Healthcare plan for patient or group",
"definition" : "Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.",
"alias" : ["Care Team"],
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Request"
},
{
"identity" : "rim",
"map" : "Act[classCode=PCPR, moodCode=INT]"
}]
},
{
"id" : "CarePlan.identifier",
"path" : "CarePlan.identifier",
"short" : "External Ids for this plan",
"definition" : "Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server.",
"comment" : "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"requirements" : "Allows identification of the care plan as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "PTH-3"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "CarePlan.instantiatesCanonical",
"path" : "CarePlan.instantiatesCanonical",
"short" : "Instantiates FHIR protocol or definition",
"definition" : "The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"http://hl7.org/fhir/StructureDefinition/Questionnaire",
"http://hl7.org/fhir/StructureDefinition/Measure",
"http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"http://hl7.org/fhir/StructureDefinition/OperationDefinition"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiatesCanonical"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "CarePlan.instantiatesUri",
"path" : "CarePlan.instantiatesUri",
"short" : "Instantiates external protocol or definition",
"definition" : "The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.",
"comment" : "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiatesUri"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "CarePlan.basedOn",
"path" : "CarePlan.basedOn",
"short" : "Fulfills CarePlan",
"definition" : "A care plan that is fulfilled in whole or in part by this care plan.",
"requirements" : "Allows tracing of the care plan and tracking whether proposals/recommendations were acted upon.",
"alias" : ["fulfills"],
"min" : 0,
"max" : "*",
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean" : true
}],
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.basedOn"
}]
},
{
"id" : "CarePlan.replaces",
"path" : "CarePlan.replaces",
"short" : "CarePlan replaced by this CarePlan",
"definition" : "Completed or terminated care plan whose function is taken by this new care plan.",
"comment" : "The replacement could be because the initial care plan was immediately rejected (due to an issue) or because the previous care plan was completed, but the need for the action described by the care plan remains ongoing.",
"requirements" : "Allows tracing the continuation of a therapy or administrative process instantiated through multiple care plans.",
"alias" : ["supersedes"],
"min" : 0,
"max" : "*",
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean" : true
}],
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.replaces"
}]
},
{
"id" : "CarePlan.partOf",
"path" : "CarePlan.partOf",
"short" : "Part of referenced CarePlan",
"definition" : "A larger care plan of which this particular care plan is a component or step.",
"comment" : "Each care plan is an independent request, such that having a care plan be part of another care plan can cause issues with cascading statuses. As such, this element is still being discussed.",
"min" : 0,
"max" : "*",
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean" : true
}],
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan"]
}],
"isSummary" : true
},
{
"id" : "CarePlan.status",
"path" : "CarePlan.status",
"short" : "draft | active | suspended | completed | entered-in-error | cancelled | unknown",
"definition" : "Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.",
"comment" : "The unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the care plan.\n\nThis element is labeled as a modifier because the status contains the code entered-in-error that marks the plan as not currently valid.",
"requirements" : "Allows clinicians to determine whether the plan is actionable or not.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CarePlanStatus"
}],
"strength" : "required",
"description" : "Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status {uses different ValueSet}"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "PTH-5"
},
{
"identity" : "rim",
"map" : ".statusCode planned = new active = active completed = completed"
}]
},
{
"id" : "CarePlan.intent",
"path" : "CarePlan.intent",
"short" : "proposal | plan | order | option",
"definition" : "Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.",
"comment" : "This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.",
"requirements" : "Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element changes the interpretation of all descriptive attributes. For example \"the time the request is recommended to occur\" vs. \"the time the request is authorized to occur\" or \"who is recommended to perform the request\" vs. \"who is authorized to perform the request\"",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CarePlanIntent"
}],
"strength" : "required",
"description" : "Codes indicating the degree of authority/intentionality associated with a care plan.",
"valueSet" : "http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.intent"
}]
},
{
"id" : "CarePlan.category",
"path" : "CarePlan.category",
"short" : "Type of plan",
"definition" : "Identifies what \"kind\" of plan this is to support differentiation between multiple co-existing plans; e.g. \"Home health\", \"psychiatric\", \"asthma\", \"disease management\", \"wellness plan\", etc.",
"comment" : "There may be multiple axes of categorization and one plan may serve multiple purposes. In some cases, this may be redundant with references to CarePlan.concern.",
"requirements" : "Used for filtering what plan(s) are retrieved and displayed to different types of users.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CarePlanCategory"
}],
"strength" : "example",
"description" : "Identifies what \"kind\" of plan this is to support differentiation between multiple co-existing plans; e.g. \"Home health\", \"psychiatric\", \"asthma\", \"disease management\", etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/care-plan-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "CarePlan.title",
"path" : "CarePlan.title",
"short" : "Human-friendly name for the care plan",
"definition" : "Human-friendly name for the care plan.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "CarePlan.description",
"path" : "CarePlan.description",
"short" : "Summary of nature of plan",
"definition" : "A description of the scope and nature of the plan.",
"requirements" : "Provides more detail than conveyed by category.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
}]
},
{
"id" : "CarePlan.subject",
"path" : "CarePlan.subject",
"short" : "Who the care plan is for",
"definition" : "Identifies the patient or group whose intended care is described by the plan.",
"alias" : ["patient"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PID-3"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PAT].role[classCode=PAT]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "CarePlan.encounter",
"path" : "CarePlan.encounter",
"short" : "Encounter created as part of",
"definition" : "The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.",
"comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. CarePlan activities conducted as a result of the care plan may well occur as part of other encounters.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.context"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "v2",
"map" : "Associated PV1"
},
{
"identity" : "rim",
"map" : "."
}]
},
{
"id" : "CarePlan.period",
"path" : "CarePlan.period",
"short" : "Time period plan covers",
"definition" : "Indicates when the plan did (or is intended to) come into effect and end.",
"comment" : "Any activities scheduled as part of the plan should be constrained to the specified period regardless of whether the activities are planned within a single encounter/episode or across multiple encounters/episodes (e.g. the longitudinal management of a chronic condition).",
"requirements" : "Allows tracking what plan(s) are in effect at a particular time.",
"alias" : ["timing"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.planned"
},
{
"identity" : "v2",
"map" : "GOL-7 / GOL-8"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "CarePlan.created",
"path" : "CarePlan.created",
"short" : "Date record was first recorded",
"definition" : "Represents when this particular CarePlan record was created in the system, which is often a system-generated date.",
"alias" : ["authoredOn"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.authoredOn"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].time"
}]
},
{
"id" : "CarePlan.author",
"path" : "CarePlan.author",
"short" : "Who is the designated responsible party",
"definition" : "When populated, the author is responsible for the care plan. The care plan is attributed to the author.",
"comment" : "The author may also be a contributor. For example, an organization can be an author, but not listed as a contributor.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/CareTeam"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.requester"
},
{
"identity" : "w5",
"map" : "FiveWs.author"
}]
},
{
"id" : "CarePlan.contributor",
"path" : "CarePlan.contributor",
"short" : "Who provided the content of the care plan",
"definition" : "Identifies the individual(s) or organization who provided the contents of the care plan.",
"comment" : "Collaborative care plans may have multiple contributors.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/CareTeam"]
}]
},
{
"id" : "CarePlan.careTeam",
"path" : "CarePlan.careTeam",
"short" : "Who's involved in plan?",
"definition" : "Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.",
"requirements" : "Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CareTeam"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performer {similar but does not entail CareTeam}"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
}]
},
{
"id" : "CarePlan.addresses",
"path" : "CarePlan.addresses",
"short" : "Health issues this plan addresses",
"definition" : "Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.",
"comment" : "When the diagnosis is related to an allergy or intolerance, the Condition and AllergyIntolerance resources can both be used. However, to be actionable for decision support, using Condition alone is not sufficient as the allergy or intolerance condition needs to be represented as an AllergyIntolerance.",
"requirements" : "Links plan to the conditions it manages. The element can identify risks addressed by the plan as well as active conditions. (The Condition resource can include things like \"at risk for hypertension\" or \"fall risk\".) Also scopes plans - multiple plans may exist addressing different concerns.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonReference"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "v2",
"map" : "PRB-4"
},
{
"identity" : "rim",
"map" : ".actRelationship[typeCode=SUBJ].target[classCode=CONC, moodCode=EVN]"
}]
},
{
"id" : "CarePlan.supportingInfo",
"path" : "CarePlan.supportingInfo",
"short" : "Information considered as part of plan",
"definition" : "Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.",
"comment" : "Use \"concern\" to identify specific conditions addressed by the care plan.",
"requirements" : "Identifies barriers and other considerations associated with the care plan.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.supportingInfo"
}]
},
{
"id" : "CarePlan.goal",
"path" : "CarePlan.goal",
"short" : "Desired outcome of plan",
"definition" : "Describes the intended objective(s) of carrying out the care plan.",
"comment" : "Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.",
"requirements" : "Provides context for plan. Allows plan effectiveness to be evaluated by clinicians.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Goal"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "GOL.1"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode<=OBJ]."
}]
},
{
"id" : "CarePlan.activity",
"path" : "CarePlan.activity",
"short" : "Action to occur as part of plan",
"definition" : "Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.",
"requirements" : "Allows systems to prompt for performance of planned activities, and validate plans against best practice.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "cpl-3",
"severity" : "error",
"human" : "Provide a reference or detail, not both",
"expression" : "detail.empty() or reference.empty()",
"xpath" : "not(exists(f:detail)) or not(exists(f:reference))"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "{no mapping\nNOTE: This is a list of contained Request-Event tuples!}"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target"
}]
},
{
"id" : "CarePlan.activity.outcomeCodeableConcept",
"path" : "CarePlan.activity.outcomeCodeableConcept",
"short" : "Results of the activity",
"definition" : "Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).",
"comment" : "Note that this should not duplicate the activity status (e.g. completed or in progress).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CarePlanActivityOutcome"
}],
"strength" : "example",
"description" : "Identifies the results of the activity.",
"valueSet" : "http://hl7.org/fhir/ValueSet/care-plan-activity-outcome"
}
},
{
"id" : "CarePlan.activity.outcomeReference",
"path" : "CarePlan.activity.outcomeReference",
"short" : "Appointment, Encounter, Procedure, etc.",
"definition" : "Details of the outcome or action resulting from the activity. The reference to an \"event\" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource).",
"comment" : "The activity outcome is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lbs and an activity is defined to diet, then the activity outcome could be calories consumed whereas the goal outcome is an observation for the actual body weight measured.",
"requirements" : "Links plan to resulting actions.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "{Event that is outcome of Request in activity.reference}"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=FLFS].source"
}]
},
{
"id" : "CarePlan.activity.progress",
"path" : "CarePlan.activity.progress",
"short" : "Comments about the activity status/progress",
"definition" : "Notes about the adherence/status/progress of the activity.",
"comment" : "This element should NOT be used to describe the activity to be performed - that occurs either within the resource pointed to by activity.detail.reference or in activity.detail.description.",
"requirements" : "Can be used to capture information about adherence, progress, concerns, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}],
"mapping" : [{
"identity" : "v2",
"map" : "NTE?"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}]
},
{
"id" : "CarePlan.activity.reference",
"path" : "CarePlan.activity.reference",
"short" : "Activity details defined in specific resource",
"definition" : "The details of the proposed activity represented in a specific resource.",
"comment" : "Standard extension exists ([resource-pertainsToGoal](extension-resource-pertainstogoal.html)) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.reference. \rThe goal should be visible when the resource referenced by CarePlan.activity.reference is viewed independently from the CarePlan. Requests that are pointed to by a CarePlan using this element should *not* point to this CarePlan using the \"basedOn\" element. i.e. Requests that are part of a CarePlan are not \"based on\" the CarePlan.",
"requirements" : "Details in a form consistent with other applications and contexts of use.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Appointment",
"http://hl7.org/fhir/StructureDefinition/CommunicationRequest",
"http://hl7.org/fhir/StructureDefinition/DeviceRequest",
"http://hl7.org/fhir/StructureDefinition/MedicationRequest",
"http://hl7.org/fhir/StructureDefinition/NutritionOrder",
"http://hl7.org/fhir/StructureDefinition/Task",
"http://hl7.org/fhir/StructureDefinition/ServiceRequest",
"http://hl7.org/fhir/StructureDefinition/VisionPrescription",
"http://hl7.org/fhir/StructureDefinition/RequestGroup"]
}],
"condition" : ["cpl-3"],
"mapping" : [{
"identity" : "workflow",
"map" : "{Request that resulted in Event in activity.actionResulting}"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target"
}]
},
{
"id" : "CarePlan.activity.detail",
"path" : "CarePlan.activity.detail",
"short" : "In-line definition of activity",
"definition" : "A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.",
"requirements" : "Details in a simple form for generic care plan systems.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["cpl-3"],
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target"
}]
},
{
"id" : "CarePlan.activity.detail.kind",
"path" : "CarePlan.activity.detail.kind",
"short" : "Kind of resource",
"definition" : "A description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.",
"requirements" : "May determine what types of extensions are permitted.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CarePlanActivityKind"
}],
"strength" : "required",
"description" : "Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.",
"valueSet" : "http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.0"
},
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=LIST].code"
}]
},
{
"id" : "CarePlan.activity.detail.instantiatesCanonical",
"path" : "CarePlan.activity.detail.instantiatesCanonical",
"short" : "Instantiates FHIR protocol or definition",
"definition" : "The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.",
"requirements" : "Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"http://hl7.org/fhir/StructureDefinition/Questionnaire",
"http://hl7.org/fhir/StructureDefinition/Measure",
"http://hl7.org/fhir/StructureDefinition/OperationDefinition"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiatesCanonical"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "CarePlan.activity.detail.instantiatesUri",
"path" : "CarePlan.activity.detail.instantiatesUri",
"short" : "Instantiates external protocol or definition",
"definition" : "The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.",
"comment" : "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.",
"requirements" : "Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "uri"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiatesUri"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "CarePlan.activity.detail.code",
"path" : "CarePlan.activity.detail.code",
"short" : "Detail type of activity",
"definition" : "Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter.",
"comment" : "Tends to be less relevant for activities involving particular products. Codes should not convey negation - use \"prohibited\" instead.",
"requirements" : "Allows matching performed to planned as well as validation against protocols.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CarePlanActivityType"
}],
"strength" : "example",
"description" : "Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.",
"valueSet" : "http://hl7.org/fhir/ValueSet/procedure-code"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "v2",
"map" : "OBR-4 / RXE-2 / RXO-1 / RXD-2"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "CarePlan.activity.detail.reasonCode",
"path" : "CarePlan.activity.detail.reasonCode",
"short" : "Why activity should be done or why activity was prohibited",
"definition" : "Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.",
"comment" : "This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CarePlanActivityReason"
}],
"strength" : "example",
"description" : "Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as \"general wellness\", prophylaxis, surgical preparation, etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/clinical-findings"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonCode"
}]
},
{
"id" : "CarePlan.activity.detail.reasonReference",
"path" : "CarePlan.activity.detail.reasonReference",
"short" : "Why activity is needed",
"definition" : "Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan.",
"comment" : "Conditions can be identified at the activity level that are not identified as reasons for the overall plan.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonReference"
}]
},
{
"id" : "CarePlan.activity.detail.goal",
"path" : "CarePlan.activity.detail.goal",
"short" : "Goals this activity relates to",
"definition" : "Internal reference that identifies the goals that this activity is intended to contribute towards meeting.",
"requirements" : "So that participants know the link explicitly.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Goal"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode<=OBJ]."
}]
},
{
"id" : "CarePlan.activity.detail.status",
"path" : "CarePlan.activity.detail.status",
"short" : "not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error",
"definition" : "Identifies what progress is being made for the specific activity.",
"comment" : "Some aspects of status can be inferred based on the resources linked in actionTaken. Note that \"status\" is only as current as the plan was most recently updated. \nThe unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the activity.",
"requirements" : "Indicates progress against the plan, whether the activity is still relevant for the plan.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the activity should not be treated as valid",
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CarePlanActivityStatus"
}],
"strength" : "required",
"description" : "Codes that reflect the current state of a care plan activity within its overall life cycle.",
"valueSet" : "http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status"
},
{
"identity" : "v2",
"map" : "ORC-5?"
},
{
"identity" : "rim",
"map" : ".statusCode not-started = new scheduled = not-started (and fulfillment relationship to appointent) in-progress = active on-hold = suspended completed = completed cancelled = aborted"
}]
},
{
"id" : "CarePlan.activity.detail.statusReason",
"path" : "CarePlan.activity.detail.statusReason",
"short" : "Reason for current status",
"definition" : "Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.",
"comment" : "Will generally not be present if status is \"complete\". Be sure to prompt to update this (or at least remove the existing value) if the status is changed.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.statusReason"
}]
},
{
"id" : "CarePlan.activity.detail.doNotPerform",
"path" : "CarePlan.activity.detail.doNotPerform",
"short" : "If true, activity is prohibiting action",
"definition" : "If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan.",
"comment" : "This element is labeled as a modifier because it marks an activity as an activity that is not to be performed.",
"requirements" : "Captures intention to not do something that may have been previously typical.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "If missing indicates that the described activity is one that should be engaged in when following the plan.",
"isModifier" : true,
"isModifierReason" : "If true this element negates the specified action. For example, instead of a request for a procedure, it is a request for the procedure to not occur.",
"mapping" : [{
"identity" : "workflow",
"map" : "Request.doNotPerform"
},
{
"identity" : "rim",
"map" : "actionNegationInd"
}]
},
{
"id" : "CarePlan.activity.detail.scheduled[x]",
"path" : "CarePlan.activity.detail.scheduled[x]",
"short" : "When activity is to occur",
"definition" : "The period, timing or frequency upon which the described activity is to occur.",
"requirements" : "Allows prompting for activities and detection of missed planned activities.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Timing"
},
{
"code" : "Period"
},
{
"code" : "string"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "v2",
"map" : "TQ1"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "CarePlan.activity.detail.location",
"path" : "CarePlan.activity.detail.location",
"short" : "Where it should happen",
"definition" : "Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.",
"comment" : "May reference a specific clinical location or may identify a type of location.",
"requirements" : "Helps in planning of activity.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "OBR-24(???!!)"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=LOC].role"
}]
},
{
"id" : "CarePlan.activity.detail.performer",
"path" : "CarePlan.activity.detail.performer",
"short" : "Who will be responsible?",
"definition" : "Identifies who's expected to be involved in the activity.",
"comment" : "A performer MAY also be a participant in the care plan.",
"requirements" : "Helps in planning of activity.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/CareTeam",
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performer"
},
{
"identity" : "v2",
"map" : "PRT-5 : ( PRV-4 = (provider participations)); PRT-5 : ( PRV-4 = (non-provider person participations )) ; PRT-5 : ( PRV-4 = (patient non-subject of care) ) ; PRT-8"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PFM]"
}]
},
{
"id" : "CarePlan.activity.detail.product[x]",
"path" : "CarePlan.activity.detail.product[x]",
"short" : "What is to be administered/supplied",
"definition" : "Identifies the food, drug or other product to be consumed or supplied in the activity.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Substance"]
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CarePlanProduct"
}],
"strength" : "example",
"description" : "A product supplied or administered as part of a care plan activity.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-codes"
},
"mapping" : [{
"identity" : "v2",
"map" : "RXE-2 / RXO-1 / RXD-2"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRD].role"
}]
},
{
"id" : "CarePlan.activity.detail.dailyAmount",
"path" : "CarePlan.activity.detail.dailyAmount",
"short" : "How to consume/day?",
"definition" : "Identifies the quantity expected to be consumed in a given day.",
"requirements" : "Allows rough dose checking.",
"alias" : ["daily dose"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "RXO-23 / RXE-19 / RXD-12"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP][classCode=SBADM].doseQuantity"
}]
},
{
"id" : "CarePlan.activity.detail.quantity",
"path" : "CarePlan.activity.detail.quantity",
"short" : "How much to administer/supply/consume",
"definition" : "Identifies the quantity expected to be supplied, administered or consumed by the subject.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "RXO-11 / RXE-10 / RXD-4 / RXG-5 / RXA-6 / TQ1-2.1 *and* RXO-12 / RXE-11 / RXD-5 / RXG-7 / RXA-7 / TQ1-2.2"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP][classCode=SPLY].quantity"
}]
},
{
"id" : "CarePlan.activity.detail.description",
"path" : "CarePlan.activity.detail.description",
"short" : "Extra info describing activity to perform",
"definition" : "This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "v2",
"map" : "NTE?"
},
{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "CarePlan.note",
"path" : "CarePlan.note",
"short" : "Comments about the plan",
"definition" : "General notes about the care plan not covered elsewhere.",
"requirements" : "Used to capture information that applies to the plan as a whole that doesn't fit into discrete elements.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.note"
},
{
"identity" : "v2",
"map" : "NTE?"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/CareTeam",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "CareTeam",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints CareTeam TU DomainResource Planned participants in the coordination and delivery of care for a patient or group
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension \r\n identifier Σ 0..* Identifier External Ids for this team
\r\n status ?!Σ 0..1 code proposed | active | suspended | inactive | entered-in-error
CareTeamStatus (Required) \r\n category Σ 0..* CodeableConcept Type of team
Care Team category (Example)
\r\n name Σ 0..1 string Name of the team, such as crisis assessment team \r\n subject Σ 0..1 Reference(Patient | Group) Who care team is for \r\n encounter Σ 0..1 Reference(Encounter) Encounter created as part of \r\n period Σ 0..1 Period Time period team covers \r\n participant I 0..* BackboneElement Members of the team
+ Rule: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner
\r\n role Σ 0..* CodeableConcept Type of involvement
Participant Roles (Example)
\r\n member Σ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Organization | CareTeam) Who is involved \r\n onBehalfOf Σ 0..1 Reference(Organization) Organization of the practitioner \r\n period 0..1 Period Time period of participant \r\n reasonCode 0..* CodeableConcept Why the care team exists
SNOMED CT Clinical Findings (Example)
\r\n reasonReference 0..* Reference(Condition) Why the care team exists
\r\n managingOrganization Σ 0..* Reference(Organization) Organization responsible for the care team
\r\n telecom 0..* ContactPoint A contact detail for the care team (that applies to all members)
\r\n note 0..* Annotation Comments made about the CareTeam
\r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Care Provision"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pc"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/CareTeam",
"version" : "4.0.0",
"name" : "CareTeam",
"status" : "draft",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (Patient Care)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}]
}],
"description" : "The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "CareTeam",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "CareTeam",
"path" : "CareTeam",
"short" : "Planned participants in the coordination and delivery of care for a patient or group",
"definition" : "The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CareTeam",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
}]
},
{
"id" : "CareTeam.id",
"path" : "CareTeam.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CareTeam.meta",
"path" : "CareTeam.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CareTeam.implicitRules",
"path" : "CareTeam.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "CareTeam.language",
"path" : "CareTeam.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "CareTeam.text",
"path" : "CareTeam.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "CareTeam.contained",
"path" : "CareTeam.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CareTeam.extension",
"path" : "CareTeam.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CareTeam.modifierExtension",
"path" : "CareTeam.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CareTeam.identifier",
"path" : "CareTeam.identifier",
"short" : "External Ids for this team",
"definition" : "Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server.",
"comment" : "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"requirements" : "Allows identification of the care team as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CareTeam.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "CareTeam.status",
"path" : "CareTeam.status",
"short" : "proposed | active | suspended | inactive | entered-in-error",
"definition" : "Indicates the current state of the care team.",
"comment" : "This element is labeled as a modifier because the status contains the code entered-in-error that marks the care team as not currently valid.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CareTeam.status",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CareTeamStatus"
}],
"strength" : "required",
"description" : "Indicates the status of the care team.",
"valueSet" : "http://hl7.org/fhir/ValueSet/care-team-status|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "CareTeam.category",
"path" : "CareTeam.category",
"short" : "Type of team",
"definition" : "Identifies what kind of team. This is to support differentiation between multiple co-existing teams, such as care plan team, episode of care team, longitudinal care team.",
"comment" : "There may be multiple axis of categorization and one team may serve multiple purposes.",
"requirements" : "Used for filtering what teams(s) are retrieved and displayed to different types of users.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CareTeam.category",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CareTeamCategory"
}],
"strength" : "example",
"description" : "Indicates the type of care team.",
"valueSet" : "http://hl7.org/fhir/ValueSet/care-team-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "CareTeam.name",
"path" : "CareTeam.name",
"short" : "Name of the team, such as crisis assessment team",
"definition" : "A label for human use intended to distinguish like teams. E.g. the \"red\" vs. \"green\" trauma teams.",
"comment" : "The meaning/purpose of the team is conveyed in CareTeam.category. This element may also convey semantics of the team (e.g. \"Red trauma team\"), but its primary purpose is to distinguish between identical teams in a human-friendly way. (\"Team 18735\" isn't as friendly.).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CareTeam.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CareTeam.subject",
"path" : "CareTeam.subject",
"short" : "Who care team is for",
"definition" : "Identifies the patient or group whose intended care is handled by the team.",
"requirements" : "Allows the team to care for a group (e.g. marriage) therapy. \nAllows for an organization to designate a team such as the PICC line team.",
"alias" : ["patient"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "CareTeam.subject",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "CareTeam.encounter",
"path" : "CareTeam.encounter",
"short" : "Encounter created as part of",
"definition" : "The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.",
"comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CareTeam.encounter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
}]
},
{
"id" : "CareTeam.period",
"path" : "CareTeam.period",
"short" : "Time period team covers",
"definition" : "Indicates when the team did (or is intended to) come into effect and end.",
"requirements" : "Allows tracking what team(s) are in effect at a particular time.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CareTeam.period",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.init"
}]
},
{
"id" : "CareTeam.participant",
"path" : "CareTeam.participant",
"short" : "Members of the team",
"definition" : "Identifies all people and organizations who are expected to be involved in the care team.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CareTeam.participant",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["ctm-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ctm-1",
"severity" : "error",
"human" : "CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner",
"expression" : "onBehalfOf.exists() implies (member.resolve() is Practitioner)",
"xpath" : "starts-with(f:member/f:reference/@value, 'Practitioner/') or contains(f:member/f:reference/@value, '/Practitioner/') or exists(ancestor::*/f:contains/f:Practitioner/f:id[@value=substring-after(current()/f:member/f:reference/@value, '#')]) or not(exists(f:onBehalfOf))"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "REL (REL.4 is always the Patient) ( or PRT?)"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF]"
}]
},
{
"id" : "CareTeam.participant.id",
"path" : "CareTeam.participant.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CareTeam.participant.extension",
"path" : "CareTeam.participant.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CareTeam.participant.modifierExtension",
"path" : "CareTeam.participant.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CareTeam.participant.role",
"path" : "CareTeam.participant.role",
"short" : "Type of involvement",
"definition" : "Indicates specific responsibility of an individual within the care team, such as \"Primary care physician\", \"Trained social worker counselor\", \"Caregiver\", etc.",
"comment" : "Roles may sometimes be inferred by type of Practitioner. These are relationships that hold only within the context of the care team. General relationships should be handled as properties of the Patient resource directly.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CareTeam.participant.role",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CareTeamParticipantRole"
}],
"strength" : "example",
"description" : "Indicates specific responsibility of an individual within the care team, such as \"Primary physician\", \"Team coordinator\", \"Caregiver\", etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/participant-role"
},
"mapping" : [{
"identity" : "v2",
"map" : "REL.2 (or PRT-4?)"
},
{
"identity" : "rim",
"map" : ".functionCode"
}]
},
{
"id" : "CareTeam.participant.member",
"path" : "CareTeam.participant.member",
"short" : "Who is involved",
"definition" : "The specific person or organization who is participating/expected to participate in the care team.",
"comment" : "Patient only needs to be listed if they have a role other than \"subject of care\".\n\nMember is optional because some participants may be known only by their role, particularly in draft plans.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CareTeam.participant.member",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/CareTeam"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "REL.5 (or PRT-5 : ( PRV-4 {provider participations} ) / PRT-5 : ( PRV-4 {non-provider person participations} ) / PRT-5 : ( PRV-4 = (patient non-subject of care) ) / PRT-8?)"
},
{
"identity" : "rim",
"map" : ".role"
}]
},
{
"id" : "CareTeam.participant.onBehalfOf",
"path" : "CareTeam.participant.onBehalfOf",
"short" : "Organization of the practitioner",
"definition" : "The organization of the practitioner.",
"requirements" : "Practitioners can be associated with multiple organizations. This element indicates which organization they were acting on behalf of.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CareTeam.participant.onBehalfOf",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CareTeam.participant.period",
"path" : "CareTeam.participant.period",
"short" : "Time period of participant",
"definition" : "Indicates when the specific member or organization did (or is intended to) come into effect and end.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CareTeam.participant.period",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CareTeam.reasonCode",
"path" : "CareTeam.reasonCode",
"short" : "Why the care team exists",
"definition" : "Describes why the care team exists.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CareTeam.reasonCode",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CareTeamReason"
}],
"strength" : "example",
"description" : "Indicates the reason for the care team.",
"valueSet" : "http://hl7.org/fhir/ValueSet/clinical-findings"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.why[x]"
}]
},
{
"id" : "CareTeam.reasonReference",
"path" : "CareTeam.reasonReference",
"short" : "Why the care team exists",
"definition" : "Condition(s) that this care team addresses.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CareTeam.reasonReference",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.why[x]"
}]
},
{
"id" : "CareTeam.managingOrganization",
"path" : "CareTeam.managingOrganization",
"short" : "Organization responsible for the care team",
"definition" : "The organization responsible for the care team.",
"requirements" : "Allows for multiple organizations to collaboratively manage cross-organizational, longitudinal care plan.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CareTeam.managingOrganization",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CareTeam.telecom",
"path" : "CareTeam.telecom",
"short" : "A contact detail for the care team (that applies to all members)",
"definition" : "A central contact detail for the care team (that applies to all members).",
"comment" : "The ContactPoint.use code of home is not appropriate to use. These contacts are not the contact details of individual care team members.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CareTeam.telecom",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactPoint"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CareTeam.note",
"path" : "CareTeam.note",
"short" : "Comments made about the CareTeam",
"definition" : "Comments made about the CareTeam.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CareTeam.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "CareTeam",
"path" : "CareTeam",
"short" : "Planned participants in the coordination and delivery of care for a patient or group",
"definition" : "The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.",
"min" : 0,
"max" : "*"
},
{
"id" : "CareTeam.identifier",
"path" : "CareTeam.identifier",
"short" : "External Ids for this team",
"definition" : "Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server.",
"comment" : "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"requirements" : "Allows identification of the care team as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "CareTeam.status",
"path" : "CareTeam.status",
"short" : "proposed | active | suspended | inactive | entered-in-error",
"definition" : "Indicates the current state of the care team.",
"comment" : "This element is labeled as a modifier because the status contains the code entered-in-error that marks the care team as not currently valid.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CareTeamStatus"
}],
"strength" : "required",
"description" : "Indicates the status of the care team.",
"valueSet" : "http://hl7.org/fhir/ValueSet/care-team-status|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "CareTeam.category",
"path" : "CareTeam.category",
"short" : "Type of team",
"definition" : "Identifies what kind of team. This is to support differentiation between multiple co-existing teams, such as care plan team, episode of care team, longitudinal care team.",
"comment" : "There may be multiple axis of categorization and one team may serve multiple purposes.",
"requirements" : "Used for filtering what teams(s) are retrieved and displayed to different types of users.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CareTeamCategory"
}],
"strength" : "example",
"description" : "Indicates the type of care team.",
"valueSet" : "http://hl7.org/fhir/ValueSet/care-team-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "CareTeam.name",
"path" : "CareTeam.name",
"short" : "Name of the team, such as crisis assessment team",
"definition" : "A label for human use intended to distinguish like teams. E.g. the \"red\" vs. \"green\" trauma teams.",
"comment" : "The meaning/purpose of the team is conveyed in CareTeam.category. This element may also convey semantics of the team (e.g. \"Red trauma team\"), but its primary purpose is to distinguish between identical teams in a human-friendly way. (\"Team 18735\" isn't as friendly.).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "CareTeam.subject",
"path" : "CareTeam.subject",
"short" : "Who care team is for",
"definition" : "Identifies the patient or group whose intended care is handled by the team.",
"requirements" : "Allows the team to care for a group (e.g. marriage) therapy. \nAllows for an organization to designate a team such as the PICC line team.",
"alias" : ["patient"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "CareTeam.encounter",
"path" : "CareTeam.encounter",
"short" : "Encounter created as part of",
"definition" : "The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.",
"comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
}]
},
{
"id" : "CareTeam.period",
"path" : "CareTeam.period",
"short" : "Time period team covers",
"definition" : "Indicates when the team did (or is intended to) come into effect and end.",
"requirements" : "Allows tracking what team(s) are in effect at a particular time.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.init"
}]
},
{
"id" : "CareTeam.participant",
"path" : "CareTeam.participant",
"short" : "Members of the team",
"definition" : "Identifies all people and organizations who are expected to be involved in the care team.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["ctm-1"],
"constraint" : [{
"key" : "ctm-1",
"severity" : "error",
"human" : "CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner",
"expression" : "onBehalfOf.exists() implies (member.resolve() is Practitioner)",
"xpath" : "starts-with(f:member/f:reference/@value, 'Practitioner/') or contains(f:member/f:reference/@value, '/Practitioner/') or exists(ancestor::*/f:contains/f:Practitioner/f:id[@value=substring-after(current()/f:member/f:reference/@value, '#')]) or not(exists(f:onBehalfOf))"
}],
"mapping" : [{
"identity" : "v2",
"map" : "REL (REL.4 is always the Patient) ( or PRT?)"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF]"
}]
},
{
"id" : "CareTeam.participant.role",
"path" : "CareTeam.participant.role",
"short" : "Type of involvement",
"definition" : "Indicates specific responsibility of an individual within the care team, such as \"Primary care physician\", \"Trained social worker counselor\", \"Caregiver\", etc.",
"comment" : "Roles may sometimes be inferred by type of Practitioner. These are relationships that hold only within the context of the care team. General relationships should be handled as properties of the Patient resource directly.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CareTeamParticipantRole"
}],
"strength" : "example",
"description" : "Indicates specific responsibility of an individual within the care team, such as \"Primary physician\", \"Team coordinator\", \"Caregiver\", etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/participant-role"
},
"mapping" : [{
"identity" : "v2",
"map" : "REL.2 (or PRT-4?)"
},
{
"identity" : "rim",
"map" : ".functionCode"
}]
},
{
"id" : "CareTeam.participant.member",
"path" : "CareTeam.participant.member",
"short" : "Who is involved",
"definition" : "The specific person or organization who is participating/expected to participate in the care team.",
"comment" : "Patient only needs to be listed if they have a role other than \"subject of care\".\n\nMember is optional because some participants may be known only by their role, particularly in draft plans.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/CareTeam"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "REL.5 (or PRT-5 : ( PRV-4 {provider participations} ) / PRT-5 : ( PRV-4 {non-provider person participations} ) / PRT-5 : ( PRV-4 = (patient non-subject of care) ) / PRT-8?)"
},
{
"identity" : "rim",
"map" : ".role"
}]
},
{
"id" : "CareTeam.participant.onBehalfOf",
"path" : "CareTeam.participant.onBehalfOf",
"short" : "Organization of the practitioner",
"definition" : "The organization of the practitioner.",
"requirements" : "Practitioners can be associated with multiple organizations. This element indicates which organization they were acting on behalf of.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true
},
{
"id" : "CareTeam.participant.period",
"path" : "CareTeam.participant.period",
"short" : "Time period of participant",
"definition" : "Indicates when the specific member or organization did (or is intended to) come into effect and end.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}]
},
{
"id" : "CareTeam.reasonCode",
"path" : "CareTeam.reasonCode",
"short" : "Why the care team exists",
"definition" : "Describes why the care team exists.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CareTeamReason"
}],
"strength" : "example",
"description" : "Indicates the reason for the care team.",
"valueSet" : "http://hl7.org/fhir/ValueSet/clinical-findings"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.why[x]"
}]
},
{
"id" : "CareTeam.reasonReference",
"path" : "CareTeam.reasonReference",
"short" : "Why the care team exists",
"definition" : "Condition(s) that this care team addresses.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.why[x]"
}]
},
{
"id" : "CareTeam.managingOrganization",
"path" : "CareTeam.managingOrganization",
"short" : "Organization responsible for the care team",
"definition" : "The organization responsible for the care team.",
"requirements" : "Allows for multiple organizations to collaboratively manage cross-organizational, longitudinal care plan.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true
},
{
"id" : "CareTeam.telecom",
"path" : "CareTeam.telecom",
"short" : "A contact detail for the care team (that applies to all members)",
"definition" : "A central contact detail for the care team (that applies to all members).",
"comment" : "The ContactPoint.use code of home is not appropriate to use. These contacts are not the contact details of individual care team members.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactPoint"
}]
},
{
"id" : "CareTeam.note",
"path" : "CareTeam.note",
"short" : "Comments made about the CareTeam",
"definition" : "Comments made about the CareTeam.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/CatalogEntry",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "CatalogEntry",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints CatalogEntry TU DomainResource An entry in a catalog
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension \r\n identifier Σ 0..* Identifier Unique identifier of the catalog item
\r\n type 0..1 CodeableConcept The type of item - medication, device, service, protocol or other \r\n orderable Σ 1..1 boolean Whether the entry represents an orderable item \r\n referencedItem Σ 1..1 Reference(Medication | Device | Organization | Practitioner | PractitionerRole | HealthcareService | ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | Binary) The item that is being defined \r\n additionalIdentifier 0..* Identifier Any additional identifier(s) for the catalog item, in the same granularity or concept
\r\n classification 0..* CodeableConcept Classification (category or class) of the item entry
\r\n status 0..1 code draft | active | retired | unknown
PublicationStatus (Required) \r\n validityPeriod 0..1 Period The time period in which this catalog entry is expected to be active \r\n validTo 0..1 dateTime The date until which this catalog entry is expected to be active \r\n lastUpdated 0..1 dateTime When was this catalog last updated \r\n additionalCharacteristic 0..* CodeableConcept Additional characteristics of the catalog entry
\r\n additionalClassification 0..* CodeableConcept Additional classification of the catalog entry
\r\n relatedEntry 0..* BackboneElement An item that this catalog entry is related to
\r\n relationtype 1..1 code triggers | is-replaced-by
CatalogEntryRelationType (Required) \r\n item 1..1 Reference(CatalogEntry) The reference to the related item \r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Documents"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "business"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "oo"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/CatalogEntry",
"version" : "4.0.0",
"name" : "CatalogEntry",
"status" : "draft",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (Orders and Observations)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/orders/index.cfm"
}]
}],
"description" : "Catalog entries are wrappers that contextualize items included in a catalog.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "CatalogEntry",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "CatalogEntry",
"path" : "CatalogEntry",
"short" : "An entry in a catalog",
"definition" : "Catalog entries are wrappers that contextualize items included in a catalog.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CatalogEntry",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
}]
},
{
"id" : "CatalogEntry.id",
"path" : "CatalogEntry.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CatalogEntry.meta",
"path" : "CatalogEntry.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CatalogEntry.implicitRules",
"path" : "CatalogEntry.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "CatalogEntry.language",
"path" : "CatalogEntry.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "CatalogEntry.text",
"path" : "CatalogEntry.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "CatalogEntry.contained",
"path" : "CatalogEntry.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CatalogEntry.extension",
"path" : "CatalogEntry.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CatalogEntry.modifierExtension",
"path" : "CatalogEntry.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CatalogEntry.identifier",
"path" : "CatalogEntry.identifier",
"short" : "Unique identifier of the catalog item",
"definition" : "Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CatalogEntry.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CatalogEntry.type",
"path" : "CatalogEntry.type",
"short" : "The type of item - medication, device, service, protocol or other",
"definition" : "The type of item - medication, device, service, protocol or other.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CatalogEntry.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CatalogEntry.orderable",
"path" : "CatalogEntry.orderable",
"short" : "Whether the entry represents an orderable item",
"definition" : "Whether the entry represents an orderable item.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CatalogEntry.orderable",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CatalogEntry.referencedItem",
"path" : "CatalogEntry.referencedItem",
"short" : "The item that is being defined",
"definition" : "The item in a catalog or definition.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CatalogEntry.referencedItem",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"http://hl7.org/fhir/StructureDefinition/SpecimenDefinition",
"http://hl7.org/fhir/StructureDefinition/ObservationDefinition",
"http://hl7.org/fhir/StructureDefinition/Binary"]
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CatalogEntry.additionalIdentifier",
"path" : "CatalogEntry.additionalIdentifier",
"short" : "Any additional identifier(s) for the catalog item, in the same granularity or concept",
"definition" : "Used in supporting related concepts, e.g. NDC to RxNorm.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CatalogEntry.additionalIdentifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CatalogEntry.classification",
"path" : "CatalogEntry.classification",
"short" : "Classification (category or class) of the item entry",
"definition" : "Classes of devices, or ATC for medication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CatalogEntry.classification",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CatalogEntry.status",
"path" : "CatalogEntry.status",
"short" : "draft | active | retired | unknown",
"definition" : "Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CatalogEntry.status",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.0"
}
},
{
"id" : "CatalogEntry.validityPeriod",
"path" : "CatalogEntry.validityPeriod",
"short" : "The time period in which this catalog entry is expected to be active",
"definition" : "The time period in which this catalog entry is expected to be active.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CatalogEntry.validityPeriod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CatalogEntry.validTo",
"path" : "CatalogEntry.validTo",
"short" : "The date until which this catalog entry is expected to be active",
"definition" : "The date until which this catalog entry is expected to be active.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CatalogEntry.validTo",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CatalogEntry.lastUpdated",
"path" : "CatalogEntry.lastUpdated",
"short" : "When was this catalog last updated",
"definition" : "Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.",
"comment" : "Perhaps not needed - if we use fhir resource metadata.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CatalogEntry.lastUpdated",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CatalogEntry.additionalCharacteristic",
"path" : "CatalogEntry.additionalCharacteristic",
"short" : "Additional characteristics of the catalog entry",
"definition" : "Used for examplefor Out of Formulary, or any specifics.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CatalogEntry.additionalCharacteristic",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CatalogEntry.additionalClassification",
"path" : "CatalogEntry.additionalClassification",
"short" : "Additional classification of the catalog entry",
"definition" : "User for example for ATC classification, or.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CatalogEntry.additionalClassification",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CatalogEntry.relatedEntry",
"path" : "CatalogEntry.relatedEntry",
"short" : "An item that this catalog entry is related to",
"definition" : "Used for example, to point to a substance, or to a device used to administer a medication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CatalogEntry.relatedEntry",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CatalogEntry.relatedEntry.id",
"path" : "CatalogEntry.relatedEntry.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CatalogEntry.relatedEntry.extension",
"path" : "CatalogEntry.relatedEntry.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CatalogEntry.relatedEntry.modifierExtension",
"path" : "CatalogEntry.relatedEntry.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CatalogEntry.relatedEntry.relationtype",
"path" : "CatalogEntry.relatedEntry.relationtype",
"short" : "triggers | is-replaced-by",
"definition" : "The type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etc.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CatalogEntry.relatedEntry.relationtype",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CatalogEntryRelationType"
}],
"strength" : "required",
"description" : "The type of relations between entries.",
"valueSet" : "http://hl7.org/fhir/ValueSet/relation-type|4.0.0"
}
},
{
"id" : "CatalogEntry.relatedEntry.item",
"path" : "CatalogEntry.relatedEntry.item",
"short" : "The reference to the related item",
"definition" : "The reference to the related item.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CatalogEntry.relatedEntry.item",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CatalogEntry"]
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "CatalogEntry",
"path" : "CatalogEntry",
"short" : "An entry in a catalog",
"definition" : "Catalog entries are wrappers that contextualize items included in a catalog.",
"min" : 0,
"max" : "*"
},
{
"id" : "CatalogEntry.identifier",
"path" : "CatalogEntry.identifier",
"short" : "Unique identifier of the catalog item",
"definition" : "Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "CatalogEntry.type",
"path" : "CatalogEntry.type",
"short" : "The type of item - medication, device, service, protocol or other",
"definition" : "The type of item - medication, device, service, protocol or other.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}]
},
{
"id" : "CatalogEntry.orderable",
"path" : "CatalogEntry.orderable",
"short" : "Whether the entry represents an orderable item",
"definition" : "Whether the entry represents an orderable item.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true
},
{
"id" : "CatalogEntry.referencedItem",
"path" : "CatalogEntry.referencedItem",
"short" : "The item that is being defined",
"definition" : "The item in a catalog or definition.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"http://hl7.org/fhir/StructureDefinition/SpecimenDefinition",
"http://hl7.org/fhir/StructureDefinition/ObservationDefinition",
"http://hl7.org/fhir/StructureDefinition/Binary"]
}],
"isSummary" : true
},
{
"id" : "CatalogEntry.additionalIdentifier",
"path" : "CatalogEntry.additionalIdentifier",
"short" : "Any additional identifier(s) for the catalog item, in the same granularity or concept",
"definition" : "Used in supporting related concepts, e.g. NDC to RxNorm.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}]
},
{
"id" : "CatalogEntry.classification",
"path" : "CatalogEntry.classification",
"short" : "Classification (category or class) of the item entry",
"definition" : "Classes of devices, or ATC for medication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}]
},
{
"id" : "CatalogEntry.status",
"path" : "CatalogEntry.status",
"short" : "draft | active | retired | unknown",
"definition" : "Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.0"
}
},
{
"id" : "CatalogEntry.validityPeriod",
"path" : "CatalogEntry.validityPeriod",
"short" : "The time period in which this catalog entry is expected to be active",
"definition" : "The time period in which this catalog entry is expected to be active.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}]
},
{
"id" : "CatalogEntry.validTo",
"path" : "CatalogEntry.validTo",
"short" : "The date until which this catalog entry is expected to be active",
"definition" : "The date until which this catalog entry is expected to be active.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}]
},
{
"id" : "CatalogEntry.lastUpdated",
"path" : "CatalogEntry.lastUpdated",
"short" : "When was this catalog last updated",
"definition" : "Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.",
"comment" : "Perhaps not needed - if we use fhir resource metadata.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}]
},
{
"id" : "CatalogEntry.additionalCharacteristic",
"path" : "CatalogEntry.additionalCharacteristic",
"short" : "Additional characteristics of the catalog entry",
"definition" : "Used for examplefor Out of Formulary, or any specifics.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}]
},
{
"id" : "CatalogEntry.additionalClassification",
"path" : "CatalogEntry.additionalClassification",
"short" : "Additional classification of the catalog entry",
"definition" : "User for example for ATC classification, or.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}]
},
{
"id" : "CatalogEntry.relatedEntry",
"path" : "CatalogEntry.relatedEntry",
"short" : "An item that this catalog entry is related to",
"definition" : "Used for example, to point to a substance, or to a device used to administer a medication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "CatalogEntry.relatedEntry.relationtype",
"path" : "CatalogEntry.relatedEntry.relationtype",
"short" : "triggers | is-replaced-by",
"definition" : "The type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etc.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CatalogEntryRelationType"
}],
"strength" : "required",
"description" : "The type of relations between entries.",
"valueSet" : "http://hl7.org/fhir/ValueSet/relation-type|4.0.0"
}
},
{
"id" : "CatalogEntry.relatedEntry.item",
"path" : "CatalogEntry.relatedEntry.item",
"short" : "The reference to the related item",
"definition" : "The reference to the related item.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CatalogEntry"]
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/ChargeItem",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "ChargeItem",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints ChargeItem TU DomainResource Item containing charge code(s) associated with the provision of healthcare provider products
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension \r\n identifier Σ 0..* Identifier Business Identifier for item
\r\n definitionUri 0..* uri Defining information about the code of this charge item
\r\n definitionCanonical 0..* canonical(ChargeItemDefinition) Resource defining the code of this ChargeItem
\r\n status ?!Σ 1..1 code planned | billable | not-billable | aborted | billed | entered-in-error | unknown
ChargeItemStatus (Required) \r\n partOf 0..* Reference(ChargeItem) Part of referenced ChargeItem
\r\n code Σ 1..1 CodeableConcept A code that identifies the charge, like a billing code
ChargeItemCode (Example) \r\n subject Σ 1..1 Reference(Patient | Group) Individual service was done for/to \r\n context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with event \r\n occurrence[x] Σ 0..1 When the charged service was applied \r\n occurrenceDateTime dateTime \r\n occurrencePeriod Period \r\n occurrenceTiming Timing \r\n performer 0..* BackboneElement Who performed charged service
\r\n function 0..1 CodeableConcept What type of performance was done
Procedure Performer Role Codes (Example) \r\n actor 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Individual who was performing \r\n performingOrganization 0..1 Reference(Organization) Organization providing the charged service \r\n requestingOrganization 0..1 Reference(Organization) Organization requesting the charged service \r\n costCenter 0..1 Reference(Organization) Organization that has ownership of the (potential, future) revenue \r\n quantity Σ 0..1 Quantity Quantity of which the charge item has been serviced \r\n bodysite Σ 0..* CodeableConcept Anatomical location, if relevant
SNOMED CT Body Structures (Example)
\r\n factorOverride 0..1 decimal Factor overriding the associated rules \r\n priceOverride 0..1 Money Price overriding the associated rules \r\n overrideReason 0..1 string Reason for overriding the list price/factor \r\n enterer Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson) Individual who was entering \r\n enteredDate Σ 0..1 dateTime Date the charge item was entered \r\n reason 0..* CodeableConcept Why was the charged service rendered?
ICD-10 Codes (Example)
\r\n service 0..* Reference(DiagnosticReport | ImagingStudy | Immunization | MedicationAdministration | MedicationDispense | Observation | Procedure | SupplyDelivery) Which rendered service is being charged?
\r\n product[x] 0..1 Product charged
FHIR Device Types (Example) \r\n productReference Reference(Device | Medication | Substance) \r\n productCodeableConcept CodeableConcept \r\n account Σ 0..* Reference(Account) Account to place this charge
\r\n note 0..* Annotation Comments made about the ChargeItem
\r\n supportingInformation 0..* Reference(Any) Further information supporting this charge
\r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Financial.General"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pa"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/ChargeItem",
"version" : "4.0.0",
"name" : "ChargeItem",
"status" : "draft",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (Patient Administration)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/pafm/index.cfm"
}]
}],
"description" : "The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "ChargeItem",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "ChargeItem",
"path" : "ChargeItem",
"short" : "Item containing charge code(s) associated with the provision of healthcare provider products",
"definition" : "The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ChargeItem",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "v2",
"map" : "FT1"
},
{
"identity" : "rim",
"map" : "Act[moodCode=EVN]"
}]
},
{
"id" : "ChargeItem.id",
"path" : "ChargeItem.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ChargeItem.meta",
"path" : "ChargeItem.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ChargeItem.implicitRules",
"path" : "ChargeItem.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "ChargeItem.language",
"path" : "ChargeItem.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "ChargeItem.text",
"path" : "ChargeItem.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "ChargeItem.contained",
"path" : "ChargeItem.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItem.extension",
"path" : "ChargeItem.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItem.modifierExtension",
"path" : "ChargeItem.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItem.identifier",
"path" : "ChargeItem.identifier",
"short" : "Business Identifier for item",
"definition" : "Identifiers assigned to this event performer or other systems.",
"requirements" : "Allows identification of the charge Item as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ChargeItem.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "FT1.2"
},
{
"identity" : "rim",
"map" : ".identifier"
}]
},
{
"id" : "ChargeItem.definitionUri",
"path" : "ChargeItem.definitionUri",
"short" : "Defining information about the code of this charge item",
"definition" : "References the (external) source of pricing information, rules of application for the code this ChargeItem uses.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ChargeItem.definitionUri",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.instantiates"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "ChargeItem.definitionCanonical",
"path" : "ChargeItem.definitionCanonical",
"short" : "Resource defining the code of this ChargeItem",
"definition" : "References the source of pricing information, rules of application for the code this ChargeItem uses.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ChargeItem.definitionCanonical",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ChargeItemDefinition"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.instantiates"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "ChargeItem.status",
"path" : "ChargeItem.status",
"short" : "planned | billable | not-billable | aborted | billed | entered-in-error | unknown",
"definition" : "The current state of the ChargeItem.",
"comment" : "Unknown does not represent \"other\" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.\n\nThis element is labeled as a modifier because the status contains the code entered-in-error that marks the charge item as not currently valid.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ChargeItem.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ChargeItemStatus"
}],
"strength" : "required",
"description" : "Codes identifying the lifecycle stage of a ChargeItem.",
"valueSet" : "http://hl7.org/fhir/ValueSet/chargeitem-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".status"
}]
},
{
"id" : "ChargeItem.partOf",
"path" : "ChargeItem.partOf",
"short" : "Part of referenced ChargeItem",
"definition" : "ChargeItems can be grouped to larger ChargeItems covering the whole set.",
"requirements" : "E.g. Drug administration as part of a procedure, procedure as part of observation, etc.",
"alias" : ["container"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "ChargeItem.partOf",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ChargeItem"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"
}]
},
{
"id" : "ChargeItem.code",
"path" : "ChargeItem.code",
"short" : "A code that identifies the charge, like a billing code",
"definition" : "A code that identifies the charge, like a billing code.",
"alias" : ["type"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "ChargeItem.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ChargeItemCode"
}],
"strength" : "example",
"description" : "Example set of codes that can be used for billing purposes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/chargeitem-billingcodes"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "FT1.7"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "ChargeItem.subject",
"path" : "ChargeItem.subject",
"short" : "Individual service was done for/to",
"definition" : "The individual or set of individuals the action is being or was performed on.",
"requirements" : "Links the event to the Patient context.",
"alias" : ["patient"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "ChargeItem.subject",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PAT in proximity to FT1 segment"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "ChargeItem.context",
"path" : "ChargeItem.context",
"short" : "Encounter / Episode associated with event",
"definition" : "The encounter or episode of care that establishes the context for this event.",
"requirements" : "Links the request to the Encounter context.",
"alias" : ["encounter"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItem.context",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter",
"http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.context"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "v2",
"map" : "PV1 in proximity to FT1 segment"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]"
}]
},
{
"id" : "ChargeItem.occurrence[x]",
"path" : "ChargeItem.occurrence[x]",
"short" : "When the charged service was applied",
"definition" : "Date/time(s) or duration when the charged service was applied.",
"comment" : "The list of types may be constrained as appropriate for the type of charge item.",
"alias" : ["timing"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItem.occurrence[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
},
{
"code" : "Timing"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "ChargeItem.performer",
"path" : "ChargeItem.performer",
"short" : "Who performed charged service",
"definition" : "Indicates who or what performed or participated in the charged service.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ChargeItem.performer",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
},
{
"identity" : "v2",
"map" : "EVN.5 or by domain"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
}]
},
{
"id" : "ChargeItem.performer.id",
"path" : "ChargeItem.performer.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ChargeItem.performer.extension",
"path" : "ChargeItem.performer.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ChargeItem.performer.modifierExtension",
"path" : "ChargeItem.performer.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItem.performer.function",
"path" : "ChargeItem.performer.function",
"short" : "What type of performance was done",
"definition" : "Describes the type of performance or participation(e.g. primary surgeon, anesthesiologiest, etc.).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItem.performer.function",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ChargeItemPerformerFunction"
}],
"strength" : "example",
"description" : "Codes describing the types of functional roles performers can take on when performing events.",
"valueSet" : "http://hl7.org/fhir/ValueSet/performer-role"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.function"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".participation.functionCode"
}]
},
{
"id" : "ChargeItem.performer.actor",
"path" : "ChargeItem.performer.actor",
"short" : "Individual who was performing",
"definition" : "The device, practitioner, etc. who performed or participated in the service.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ChargeItem.performer.actor",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/CareTeam",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "EVN.5 or by domain"
},
{
"identity" : "rim",
"map" : ".player"
}]
},
{
"id" : "ChargeItem.performingOrganization",
"path" : "ChargeItem.performingOrganization",
"short" : "Organization providing the charged service",
"definition" : "The organization requesting the service.",
"comment" : "Practitioners and Devices can be associated with multiple organizations. It has to be made clear, on behalf of which Organization the services have been rendered.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItem.performingOrganization",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : ".scoper"
}]
},
{
"id" : "ChargeItem.requestingOrganization",
"path" : "ChargeItem.requestingOrganization",
"short" : "Organization requesting the charged service",
"definition" : "The organization performing the service.",
"comment" : "The rendered Service might not be associated with a Request. This property indicates which Organization requested the services to be rendered. (In many cases, this may just be the Department associated with the Encounter.location).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItem.requestingOrganization",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : ".scoper"
}]
},
{
"id" : "ChargeItem.costCenter",
"path" : "ChargeItem.costCenter",
"short" : "Organization that has ownership of the (potential, future) revenue",
"definition" : "The financial cost center permits the tracking of charge attribution.",
"comment" : "The costCenter could either be given as a reference to an Organization(Role) resource or as the identifier of the cost center determined by Reference.identifier.value and Reference.identifier.system, depending on use case requirements.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItem.costCenter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "FT1.13"
}]
},
{
"id" : "ChargeItem.quantity",
"path" : "ChargeItem.quantity",
"short" : "Quantity of which the charge item has been serviced",
"definition" : "Quantity of which the charge item has been serviced.",
"comment" : "In many cases this may just be a value, if the underlying units are implicit in the definition of the charge item code.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItem.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "FT1.10"
}]
},
{
"id" : "ChargeItem.bodysite",
"path" : "ChargeItem.bodysite",
"short" : "Anatomical location, if relevant",
"definition" : "The anatomical location where the related service has been applied.",
"comment" : "Only used if not implicit in code found in Condition.code. If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension [bodySite](extension-bodysite.html). May be a summary code, or a reference to a very precise definition of the location, or both.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ChargeItem.bodysite",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BodySite"
}],
"strength" : "example",
"description" : "Codes describing anatomical locations. May include laterality.",
"valueSet" : "http://hl7.org/fhir/ValueSet/body-site"
},
"mapping" : [{
"identity" : "rim",
"map" : ".targetBodySiteCode"
}]
},
{
"id" : "ChargeItem.factorOverride",
"path" : "ChargeItem.factorOverride",
"short" : "Factor overriding the associated rules",
"definition" : "Factor overriding the factor determined by the rules associated with the code.",
"comment" : "There is no reason to carry the factor in the instance of a ChargeItem unless special circumstances require a manual override. The factors are usually defined by a set of rules in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItem.factorOverride",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "FT1.26"
}]
},
{
"id" : "ChargeItem.priceOverride",
"path" : "ChargeItem.priceOverride",
"short" : "Price overriding the associated rules",
"definition" : "Total price of the charge overriding the list price associated with the code.",
"comment" : "There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItem.priceOverride",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Money"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "FT1.22"
}]
},
{
"id" : "ChargeItem.overrideReason",
"path" : "ChargeItem.overrideReason",
"short" : "Reason for overriding the list price/factor",
"definition" : "If the list price or the rule-based factor associated with the code is overridden, this attribute can capture a text to indicate the reason for this action.",
"comment" : "Derived Profiles may choose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItem.overrideReason",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ChargeItem.enterer",
"path" : "ChargeItem.enterer",
"short" : "Individual who was entering",
"definition" : "The device, practitioner, etc. who entered the charge item.",
"comment" : "The enterer is also the person considered responsible for factor/price overrides if applicable.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItem.enterer",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "EVN.5 or by domain"
},
{
"identity" : "rim",
"map" : ".player"
}]
},
{
"id" : "ChargeItem.enteredDate",
"path" : "ChargeItem.enteredDate",
"short" : "Date the charge item was entered",
"definition" : "Date the charge item was entered.",
"comment" : "The actual date when the service associated with the charge has been rendered is captured in occurrence[x].",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItem.enteredDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ChargeItem.reason",
"path" : "ChargeItem.reason",
"short" : "Why was the charged service rendered?",
"definition" : "Describes why the event occurred in coded or textual form.",
"comment" : "If the application of the charge item requires a reason to be given, it can be captured here. Textual reasons can be captured using reasonCode.text.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ChargeItem.reason",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ChargeItemReason"
}],
"strength" : "example",
"description" : "Example binding for reason.",
"valueSet" : "http://hl7.org/fhir/ValueSet/icd-10"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "v2",
"map" : "EVN.4 or by domain"
},
{
"identity" : "rim",
"map" : ".reasonCode"
}]
},
{
"id" : "ChargeItem.service",
"path" : "ChargeItem.service",
"short" : "Which rendered service is being charged?",
"definition" : "Indicated the rendered service that caused this charge.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ChargeItem.service",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"http://hl7.org/fhir/StructureDefinition/Immunization",
"http://hl7.org/fhir/StructureDefinition/MedicationAdministration",
"http://hl7.org/fhir/StructureDefinition/MedicationDispense",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/Procedure",
"http://hl7.org/fhir/StructureDefinition/SupplyDelivery"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonReference"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "v2",
"map" : "EVN.4 or by domain"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RSON].target"
}]
},
{
"id" : "ChargeItem.product[x]",
"path" : "ChargeItem.product[x]",
"short" : "Product charged",
"definition" : "Identifies the device, food, drug or other product being charged either by type code or reference to an instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItem.product[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Substance"]
},
{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ChargeItemProduct"
}],
"strength" : "example",
"description" : "Example binding for product type.",
"valueSet" : "http://hl7.org/fhir/ValueSet/device-kind"
},
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=CSM].role"
}]
},
{
"id" : "ChargeItem.account",
"path" : "ChargeItem.account",
"short" : "Account to place this charge",
"definition" : "Account into which this ChargeItems belongs.",
"comment" : "Systems posting the ChargeItems might not always be able to determine, which accounts the Items need to be places into. It is up to the postprocessing Financial System to apply internal rules to decide based on the Encounter/EpisodeOfCare/Patient/Coverage context and the type of ChargeItem, which Account is appropriate.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ChargeItem.account",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Account"]
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ChargeItem.note",
"path" : "ChargeItem.note",
"short" : "Comments made about the ChargeItem",
"definition" : "Comments made about the event by the performer, subject or other participants.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ChargeItem.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
},
{
"identity" : "v2",
"map" : "NTE"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]"
}]
},
{
"id" : "ChargeItem.supportingInformation",
"path" : "ChargeItem.supportingInformation",
"short" : "Further information supporting this charge",
"definition" : "Further information supporting this charge.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ChargeItem.supportingInformation",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.supportingInfo"
}]
}]
},
"differential" : {
"element" : [{
"id" : "ChargeItem",
"path" : "ChargeItem",
"short" : "Item containing charge code(s) associated with the provision of healthcare provider products",
"definition" : "The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "v2",
"map" : "FT1"
},
{
"identity" : "rim",
"map" : "Act[moodCode=EVN]"
}]
},
{
"id" : "ChargeItem.identifier",
"path" : "ChargeItem.identifier",
"short" : "Business Identifier for item",
"definition" : "Identifiers assigned to this event performer or other systems.",
"requirements" : "Allows identification of the charge Item as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "FT1.2"
},
{
"identity" : "rim",
"map" : ".identifier"
}]
},
{
"id" : "ChargeItem.definitionUri",
"path" : "ChargeItem.definitionUri",
"short" : "Defining information about the code of this charge item",
"definition" : "References the (external) source of pricing information, rules of application for the code this ChargeItem uses.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "uri"
}],
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.instantiates"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "ChargeItem.definitionCanonical",
"path" : "ChargeItem.definitionCanonical",
"short" : "Resource defining the code of this ChargeItem",
"definition" : "References the source of pricing information, rules of application for the code this ChargeItem uses.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ChargeItemDefinition"]
}],
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.instantiates"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "ChargeItem.status",
"path" : "ChargeItem.status",
"short" : "planned | billable | not-billable | aborted | billed | entered-in-error | unknown",
"definition" : "The current state of the ChargeItem.",
"comment" : "Unknown does not represent \"other\" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.\n\nThis element is labeled as a modifier because the status contains the code entered-in-error that marks the charge item as not currently valid.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ChargeItemStatus"
}],
"strength" : "required",
"description" : "Codes identifying the lifecycle stage of a ChargeItem.",
"valueSet" : "http://hl7.org/fhir/ValueSet/chargeitem-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".status"
}]
},
{
"id" : "ChargeItem.partOf",
"path" : "ChargeItem.partOf",
"short" : "Part of referenced ChargeItem",
"definition" : "ChargeItems can be grouped to larger ChargeItems covering the whole set.",
"requirements" : "E.g. Drug administration as part of a procedure, procedure as part of observation, etc.",
"alias" : ["container"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ChargeItem"]
}],
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"
}]
},
{
"id" : "ChargeItem.code",
"path" : "ChargeItem.code",
"short" : "A code that identifies the charge, like a billing code",
"definition" : "A code that identifies the charge, like a billing code.",
"alias" : ["type"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ChargeItemCode"
}],
"strength" : "example",
"description" : "Example set of codes that can be used for billing purposes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/chargeitem-billingcodes"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "FT1.7"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "ChargeItem.subject",
"path" : "ChargeItem.subject",
"short" : "Individual service was done for/to",
"definition" : "The individual or set of individuals the action is being or was performed on.",
"requirements" : "Links the event to the Patient context.",
"alias" : ["patient"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PAT in proximity to FT1 segment"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "ChargeItem.context",
"path" : "ChargeItem.context",
"short" : "Encounter / Episode associated with event",
"definition" : "The encounter or episode of care that establishes the context for this event.",
"requirements" : "Links the request to the Encounter context.",
"alias" : ["encounter"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter",
"http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.context"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "v2",
"map" : "PV1 in proximity to FT1 segment"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]"
}]
},
{
"id" : "ChargeItem.occurrence[x]",
"path" : "ChargeItem.occurrence[x]",
"short" : "When the charged service was applied",
"definition" : "Date/time(s) or duration when the charged service was applied.",
"comment" : "The list of types may be constrained as appropriate for the type of charge item.",
"alias" : ["timing"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
},
{
"code" : "Timing"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "ChargeItem.performer",
"path" : "ChargeItem.performer",
"short" : "Who performed charged service",
"definition" : "Indicates who or what performed or participated in the charged service.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
},
{
"identity" : "v2",
"map" : "EVN.5 or by domain"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
}]
},
{
"id" : "ChargeItem.performer.function",
"path" : "ChargeItem.performer.function",
"short" : "What type of performance was done",
"definition" : "Describes the type of performance or participation(e.g. primary surgeon, anesthesiologiest, etc.).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ChargeItemPerformerFunction"
}],
"strength" : "example",
"description" : "Codes describing the types of functional roles performers can take on when performing events.",
"valueSet" : "http://hl7.org/fhir/ValueSet/performer-role"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.function"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".participation.functionCode"
}]
},
{
"id" : "ChargeItem.performer.actor",
"path" : "ChargeItem.performer.actor",
"short" : "Individual who was performing",
"definition" : "The device, practitioner, etc. who performed or participated in the service.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/CareTeam",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "EVN.5 or by domain"
},
{
"identity" : "rim",
"map" : ".player"
}]
},
{
"id" : "ChargeItem.performingOrganization",
"path" : "ChargeItem.performingOrganization",
"short" : "Organization providing the charged service",
"definition" : "The organization requesting the service.",
"comment" : "Practitioners and Devices can be associated with multiple organizations. It has to be made clear, on behalf of which Organization the services have been rendered.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : ".scoper"
}]
},
{
"id" : "ChargeItem.requestingOrganization",
"path" : "ChargeItem.requestingOrganization",
"short" : "Organization requesting the charged service",
"definition" : "The organization performing the service.",
"comment" : "The rendered Service might not be associated with a Request. This property indicates which Organization requested the services to be rendered. (In many cases, this may just be the Department associated with the Encounter.location).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : ".scoper"
}]
},
{
"id" : "ChargeItem.costCenter",
"path" : "ChargeItem.costCenter",
"short" : "Organization that has ownership of the (potential, future) revenue",
"definition" : "The financial cost center permits the tracking of charge attribution.",
"comment" : "The costCenter could either be given as a reference to an Organization(Role) resource or as the identifier of the cost center determined by Reference.identifier.value and Reference.identifier.system, depending on use case requirements.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "FT1.13"
}]
},
{
"id" : "ChargeItem.quantity",
"path" : "ChargeItem.quantity",
"short" : "Quantity of which the charge item has been serviced",
"definition" : "Quantity of which the charge item has been serviced.",
"comment" : "In many cases this may just be a value, if the underlying units are implicit in the definition of the charge item code.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "FT1.10"
}]
},
{
"id" : "ChargeItem.bodysite",
"path" : "ChargeItem.bodysite",
"short" : "Anatomical location, if relevant",
"definition" : "The anatomical location where the related service has been applied.",
"comment" : "Only used if not implicit in code found in Condition.code. If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension [bodySite](extension-bodysite.html). May be a summary code, or a reference to a very precise definition of the location, or both.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BodySite"
}],
"strength" : "example",
"description" : "Codes describing anatomical locations. May include laterality.",
"valueSet" : "http://hl7.org/fhir/ValueSet/body-site"
},
"mapping" : [{
"identity" : "rim",
"map" : ".targetBodySiteCode"
}]
},
{
"id" : "ChargeItem.factorOverride",
"path" : "ChargeItem.factorOverride",
"short" : "Factor overriding the associated rules",
"definition" : "Factor overriding the factor determined by the rules associated with the code.",
"comment" : "There is no reason to carry the factor in the instance of a ChargeItem unless special circumstances require a manual override. The factors are usually defined by a set of rules in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}],
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "FT1.26"
}]
},
{
"id" : "ChargeItem.priceOverride",
"path" : "ChargeItem.priceOverride",
"short" : "Price overriding the associated rules",
"definition" : "Total price of the charge overriding the list price associated with the code.",
"comment" : "There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}],
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "FT1.22"
}]
},
{
"id" : "ChargeItem.overrideReason",
"path" : "ChargeItem.overrideReason",
"short" : "Reason for overriding the list price/factor",
"definition" : "If the list price or the rule-based factor associated with the code is overridden, this attribute can capture a text to indicate the reason for this action.",
"comment" : "Derived Profiles may choose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : false
},
{
"id" : "ChargeItem.enterer",
"path" : "ChargeItem.enterer",
"short" : "Individual who was entering",
"definition" : "The device, practitioner, etc. who entered the charge item.",
"comment" : "The enterer is also the person considered responsible for factor/price overrides if applicable.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "EVN.5 or by domain"
},
{
"identity" : "rim",
"map" : ".player"
}]
},
{
"id" : "ChargeItem.enteredDate",
"path" : "ChargeItem.enteredDate",
"short" : "Date the charge item was entered",
"definition" : "Date the charge item was entered.",
"comment" : "The actual date when the service associated with the charge has been rendered is captured in occurrence[x].",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true
},
{
"id" : "ChargeItem.reason",
"path" : "ChargeItem.reason",
"short" : "Why was the charged service rendered?",
"definition" : "Describes why the event occurred in coded or textual form.",
"comment" : "If the application of the charge item requires a reason to be given, it can be captured here. Textual reasons can be captured using reasonCode.text.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ChargeItemReason"
}],
"strength" : "example",
"description" : "Example binding for reason.",
"valueSet" : "http://hl7.org/fhir/ValueSet/icd-10"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "v2",
"map" : "EVN.4 or by domain"
},
{
"identity" : "rim",
"map" : ".reasonCode"
}]
},
{
"id" : "ChargeItem.service",
"path" : "ChargeItem.service",
"short" : "Which rendered service is being charged?",
"definition" : "Indicated the rendered service that caused this charge.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"http://hl7.org/fhir/StructureDefinition/Immunization",
"http://hl7.org/fhir/StructureDefinition/MedicationAdministration",
"http://hl7.org/fhir/StructureDefinition/MedicationDispense",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/Procedure",
"http://hl7.org/fhir/StructureDefinition/SupplyDelivery"]
}],
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonReference"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "v2",
"map" : "EVN.4 or by domain"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RSON].target"
}]
},
{
"id" : "ChargeItem.product[x]",
"path" : "ChargeItem.product[x]",
"short" : "Product charged",
"definition" : "Identifies the device, food, drug or other product being charged either by type code or reference to an instance.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Substance"]
},
{
"code" : "CodeableConcept"
}],
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ChargeItemProduct"
}],
"strength" : "example",
"description" : "Example binding for product type.",
"valueSet" : "http://hl7.org/fhir/ValueSet/device-kind"
},
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=CSM].role"
}]
},
{
"id" : "ChargeItem.account",
"path" : "ChargeItem.account",
"short" : "Account to place this charge",
"definition" : "Account into which this ChargeItems belongs.",
"comment" : "Systems posting the ChargeItems might not always be able to determine, which accounts the Items need to be places into. It is up to the postprocessing Financial System to apply internal rules to decide based on the Encounter/EpisodeOfCare/Patient/Coverage context and the type of ChargeItem, which Account is appropriate.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Account"]
}],
"isSummary" : true
},
{
"id" : "ChargeItem.note",
"path" : "ChargeItem.note",
"short" : "Comments made about the ChargeItem",
"definition" : "Comments made about the event by the performer, subject or other participants.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}],
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
},
{
"identity" : "v2",
"map" : "NTE"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]"
}]
},
{
"id" : "ChargeItem.supportingInformation",
"path" : "ChargeItem.supportingInformation",
"short" : "Further information supporting this charge",
"definition" : "Further information supporting this charge.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.supportingInfo"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/ChargeItemDefinition",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "ChargeItemDefinition",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints ChargeItemDefinition ITU DomainResource Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension \r\n url Σ 1..1 uri Canonical identifier for this charge item definition, represented as a URI (globally unique) \r\n identifier Σ 0..* Identifier Additional identifier for the charge item definition
\r\n version Σ 0..1 string Business version of the charge item definition \r\n title Σ 0..1 string Name for this charge item definition (human friendly) \r\n derivedFromUri Σ 0..* uri Underlying externally-defined charge item definition
\r\n partOf Σ 0..* canonical(ChargeItemDefinition) A larger definition of which this particular definition is a component or step
\r\n replaces Σ 0..* canonical(ChargeItemDefinition) Completed or terminated request(s) whose function is taken by this new request
\r\n status ?!Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required) \r\n experimental Σ 0..1 boolean For testing purposes, not real usage \r\n date Σ 0..1 dateTime Date last changed \r\n publisher Σ 0..1 string Name of the publisher (organization or individual) \r\n contact Σ 0..* ContactDetail Contact details for the publisher
\r\n description Σ 0..1 markdown Natural language description of the charge item definition \r\n useContext Σ 0..* UsageContext The context that the content is intended to support
\r\n jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for charge item definition (if applicable)
Jurisdiction (Extensible)
\r\n copyright 0..1 markdown Use and/or publishing restrictions \r\n approvalDate 0..1 date When the charge item definition was approved by publisher \r\n lastReviewDate 0..1 date When the charge item definition was last reviewed \r\n effectivePeriod Σ 0..1 Period When the charge item definition is expected to be used \r\n code Σ 0..1 CodeableConcept Billing codes or product types this definition applies to
ChargeItemCode (Example) \r\n instance 0..* Reference(Medication | Substance | Device) Instances this definition applies to
\r\n applicability 0..* BackboneElement Whether or not the billing code is applicable
\r\n description 0..1 string Natural language description of the condition \r\n language 0..1 string Language of the expression \r\n expression 0..1 string Boolean-valued expression \r\n propertyGroup 0..* BackboneElement Group of properties which are applicable under the same conditions
\r\n applicability 0..* see applicability Conditions under which the priceComponent is applicable
\r\n priceComponent 0..* BackboneElement Components of total line item price
\r\n type 1..1 code base | surcharge | deduction | discount | tax | informational
InvoicePriceComponentType (Required) \r\n code 0..1 CodeableConcept Code identifying the specific component \r\n factor 0..1 decimal Factor used for calculating this component \r\n amount 0..1 Money Monetary amount associated with this component \r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Financial.General"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "business"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pa"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/ChargeItemDefinition",
"version" : "4.0.0",
"name" : "ChargeItemDefinition",
"status" : "draft",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (Patient Administration)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/pafm/index.cfm"
}]
}],
"description" : "The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "objimpl",
"uri" : "http://hl7.org/fhir/object-implementation",
"name" : "Object Implementation Information"
}],
"kind" : "resource",
"abstract" : false,
"type" : "ChargeItemDefinition",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString" : "MetadataResource"
}]
},
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "ChargeItemDefinition",
"path" : "ChargeItemDefinition",
"short" : "Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined",
"definition" : "The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ChargeItemDefinition",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
},
{
"key" : "cid-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.id",
"path" : "ChargeItemDefinition.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ChargeItemDefinition.meta",
"path" : "ChargeItemDefinition.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ChargeItemDefinition.implicitRules",
"path" : "ChargeItemDefinition.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "ChargeItemDefinition.language",
"path" : "ChargeItemDefinition.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "ChargeItemDefinition.text",
"path" : "ChargeItemDefinition.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "ChargeItemDefinition.contained",
"path" : "ChargeItemDefinition.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.extension",
"path" : "ChargeItemDefinition.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.modifierExtension",
"path" : "ChargeItemDefinition.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.url",
"path" : "ChargeItemDefinition.url",
"short" : "Canonical identifier for this charge item definition, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this charge item definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this charge item definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the charge item definition is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the charge item definition to be referenced by a single globally unique identifier.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ChargeItemDefinition.url",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.identifier",
"path" : "ChargeItemDefinition.identifier",
"short" : "Additional identifier for the charge item definition",
"definition" : "A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this charge item definition outside of FHIR, where it is not possible to use the logical URI.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ChargeItemDefinition.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : "N/A"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ChargeItemDefinition.version",
"path" : "ChargeItemDefinition.version",
"short" : "Business version of the charge item definition",
"definition" : "The identifier that is used to identify this version of the charge item definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the charge item definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.",
"comment" : "There may be different charge item definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the charge item definition with the format [url]|[version].",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItemDefinition.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.title",
"path" : "ChargeItemDefinition.title",
"short" : "Name for this charge item definition (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the charge item definition.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItemDefinition.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.derivedFromUri",
"path" : "ChargeItemDefinition.derivedFromUri",
"short" : "Underlying externally-defined charge item definition",
"definition" : "The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ChargeItemDefinition.derivedFromUri",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.partOf",
"path" : "ChargeItemDefinition.partOf",
"short" : "A larger definition of which this particular definition is a component or step",
"definition" : "A larger definition of which this particular definition is a component or step.",
"alias" : ["container"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "ChargeItemDefinition.partOf",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ChargeItemDefinition"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.replaces",
"path" : "ChargeItemDefinition.replaces",
"short" : "Completed or terminated request(s) whose function is taken by this new request",
"definition" : "As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.",
"alias" : ["supersedes",
"prior",
"renewed order"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "ChargeItemDefinition.replaces",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ChargeItemDefinition"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.status",
"path" : "ChargeItemDefinition.status",
"short" : "draft | active | retired | unknown",
"definition" : "The current state of the ChargeItemDefinition.",
"comment" : "Allows filtering of charge item definitions that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ChargeItemDefinition.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status {different ValueSet}"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.experimental",
"path" : "ChargeItemDefinition.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of charge item definitions that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level charge item definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItemDefinition.experimental",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.date",
"path" : "ChargeItemDefinition.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the charge item definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the charge item definition changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the charge item definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItemDefinition.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.publisher",
"path" : "ChargeItemDefinition.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the charge item definition.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the charge item definition is the organization or individual primarily responsible for the maintenance and upkeep of the charge item definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the charge item definition. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the charge item definition. May also allow for contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItemDefinition.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher {as string instead of CodeableConcept}"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.contact",
"path" : "ChargeItemDefinition.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ChargeItemDefinition.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.description",
"path" : "ChargeItemDefinition.description",
"short" : "Natural language description of the charge item definition",
"definition" : "A free text natural language description of the charge item definition from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the charge item definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the charge item definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the charge item definition is presumed to be the predominant language in the place the charge item definition was created).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItemDefinition.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.useContext",
"path" : "ChargeItemDefinition.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate charge item definition instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ChargeItemDefinition.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.jurisdiction",
"path" : "ChargeItemDefinition.jurisdiction",
"short" : "Intended jurisdiction for charge item definition (if applicable)",
"definition" : "A legal or geographic region in which the charge item definition is intended to be used.",
"comment" : "It may be possible for the charge item definition to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ChargeItemDefinition.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.copyright",
"path" : "ChargeItemDefinition.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the charge item definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the charge item definition.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the charge item definition and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItemDefinition.copyright",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "rim",
"map" : "N/A"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ChargeItemDefinition.approvalDate",
"path" : "ChargeItemDefinition.approvalDate",
"short" : "When the charge item definition was approved by publisher",
"definition" : "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comment" : "The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItemDefinition.approvalDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.approvalDate"
},
{
"identity" : "rim",
"map" : "N/A"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ChargeItemDefinition.lastReviewDate",
"path" : "ChargeItemDefinition.lastReviewDate",
"short" : "When the charge item definition was last reviewed",
"definition" : "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"comment" : "If specified, this date follows the original approval date.",
"requirements" : "Gives a sense of how \"current\" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItemDefinition.lastReviewDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.lastReviewDate"
},
{
"identity" : "rim",
"map" : "N/A"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ChargeItemDefinition.effectivePeriod",
"path" : "ChargeItemDefinition.effectivePeriod",
"short" : "When the charge item definition is expected to be used",
"definition" : "The period during which the charge item definition content was or is planned to be in active use.",
"comment" : "The effective period for a charge item definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.",
"requirements" : "Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the charge item definition are or are expected to be used instead.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItemDefinition.effectivePeriod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.effectivePeriod"
},
{
"identity" : "rim",
"map" : "N/A"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ChargeItemDefinition.code",
"path" : "ChargeItemDefinition.code",
"short" : "Billing codes or product types this definition applies to",
"definition" : "The defined billing details in this resource pertain to the given billing code.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItemDefinition.code",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ChargeItemDefinitionCode"
}],
"strength" : "example",
"description" : "Billing Code defined by this ChargeItemDefinition.",
"valueSet" : "http://hl7.org/fhir/ValueSet/chargeitem-billingcodes"
},
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.instance",
"path" : "ChargeItemDefinition.instance",
"short" : "Instances this definition applies to",
"definition" : "The defined billing details in this resource pertain to the given product instance(s).",
"comment" : "In case of highly customized, individually produced or fitted devices/substances, the pricing information may be different for each instance of the product. This reference links pricing details to specific product instances.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ChargeItemDefinition.instance",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Substance",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.applicability",
"path" : "ChargeItemDefinition.applicability",
"short" : "Whether or not the billing code is applicable",
"definition" : "Expressions that describe applicability criteria for the billing code.",
"comment" : "The applicability conditions can be used to ascertain whether a billing item is allowed in a specific context. E.g. some billing codes may only be applicable in out-patient settings, only to male/female patients or only to children.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ChargeItemDefinition.applicability",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.applicability.id",
"path" : "ChargeItemDefinition.applicability.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ChargeItemDefinition.applicability.extension",
"path" : "ChargeItemDefinition.applicability.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ChargeItemDefinition.applicability.modifierExtension",
"path" : "ChargeItemDefinition.applicability.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.applicability.description",
"path" : "ChargeItemDefinition.applicability.description",
"short" : "Natural language description of the condition",
"definition" : "A brief, natural language description of the condition that effectively communicates the intended semantics.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItemDefinition.applicability.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.applicability.language",
"path" : "ChargeItemDefinition.applicability.language",
"short" : "Language of the expression",
"definition" : "The media type of the language for the expression, e.g. \"text/cql\" for Clinical Query Language expressions or \"text/fhirpath\" for FHIRPath expressions.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItemDefinition.applicability.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.applicability.expression",
"path" : "ChargeItemDefinition.applicability.expression",
"short" : "Boolean-valued expression",
"definition" : "An expression that returns true or false, indicating whether the condition is satisfied. When using FHIRPath expressions, the %context environment variable must be replaced at runtime with the ChargeItem resource to which this definition is applied.",
"comment" : "Please note that FHIRPath Expressions can only be evaluated in the scope of the current ChargeItem resource to which this definition is being applied.\nFHIRPath expressions can traverse into other resources linked from the ChargeItem resource, however, testing rules such as that a billing code may be billed only once per encounter need a wider scope. In such scenarios, CQL may be the appropriate choice.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItemDefinition.applicability.expression",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.propertyGroup",
"path" : "ChargeItemDefinition.propertyGroup",
"short" : "Group of properties which are applicable under the same conditions",
"definition" : "Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ChargeItemDefinition.propertyGroup",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.propertyGroup.id",
"path" : "ChargeItemDefinition.propertyGroup.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ChargeItemDefinition.propertyGroup.extension",
"path" : "ChargeItemDefinition.propertyGroup.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ChargeItemDefinition.propertyGroup.modifierExtension",
"path" : "ChargeItemDefinition.propertyGroup.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.propertyGroup.applicability",
"path" : "ChargeItemDefinition.propertyGroup.applicability",
"short" : "Conditions under which the priceComponent is applicable",
"definition" : "Expressions that describe applicability criteria for the priceComponent.",
"comment" : "The applicability conditions can be used to ascertain whether a billing item is allowed in a specific context. E.g. some billing codes may only be applicable in out-patient settings, only to male/female patients or only to children.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ChargeItemDefinition.propertyGroup.applicability",
"min" : 0,
"max" : "*"
},
"contentReference" : "#ChargeItemDefinition.applicability",
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.propertyGroup.priceComponent",
"path" : "ChargeItemDefinition.propertyGroup.priceComponent",
"short" : "Components of total line item price",
"definition" : "The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the prices have been calculated.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ChargeItemDefinition.propertyGroup.priceComponent",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.propertyGroup.priceComponent.id",
"path" : "ChargeItemDefinition.propertyGroup.priceComponent.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ChargeItemDefinition.propertyGroup.priceComponent.extension",
"path" : "ChargeItemDefinition.propertyGroup.priceComponent.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ChargeItemDefinition.propertyGroup.priceComponent.modifierExtension",
"path" : "ChargeItemDefinition.propertyGroup.priceComponent.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.propertyGroup.priceComponent.type",
"path" : "ChargeItemDefinition.propertyGroup.priceComponent.type",
"short" : "base | surcharge | deduction | discount | tax | informational",
"definition" : "This code identifies the type of the component.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ChargeItemDefinition.propertyGroup.priceComponent.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ChargeItemDefinitionPriceComponentType"
}],
"strength" : "required",
"description" : "Codes indicating the kind of the price component.",
"valueSet" : "http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.0"
},
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.propertyGroup.priceComponent.code",
"path" : "ChargeItemDefinition.propertyGroup.priceComponent.code",
"short" : "Code identifying the specific component",
"definition" : "A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItemDefinition.propertyGroup.priceComponent.code",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.propertyGroup.priceComponent.factor",
"path" : "ChargeItemDefinition.propertyGroup.priceComponent.factor",
"short" : "Factor used for calculating this component",
"definition" : "The factor that has been applied on the base price for calculating this component.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItemDefinition.propertyGroup.priceComponent.factor",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.propertyGroup.priceComponent.amount",
"path" : "ChargeItemDefinition.propertyGroup.priceComponent.amount",
"short" : "Monetary amount associated with this component",
"definition" : "The amount calculated for this component.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ChargeItemDefinition.propertyGroup.priceComponent.amount",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Money"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
}]
},
"differential" : {
"element" : [{
"id" : "ChargeItemDefinition",
"path" : "ChargeItemDefinition",
"short" : "Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined",
"definition" : "The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "cid-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.url",
"path" : "ChargeItemDefinition.url",
"short" : "Canonical identifier for this charge item definition, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this charge item definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this charge item definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the charge item definition is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the charge item definition to be referenced by a single globally unique identifier.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.identifier",
"path" : "ChargeItemDefinition.identifier",
"short" : "Additional identifier for the charge item definition",
"definition" : "A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this charge item definition outside of FHIR, where it is not possible to use the logical URI.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : "N/A"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ChargeItemDefinition.version",
"path" : "ChargeItemDefinition.version",
"short" : "Business version of the charge item definition",
"definition" : "The identifier that is used to identify this version of the charge item definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the charge item definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.",
"comment" : "There may be different charge item definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the charge item definition with the format [url]|[version].",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.title",
"path" : "ChargeItemDefinition.title",
"short" : "Name for this charge item definition (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the charge item definition.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.derivedFromUri",
"path" : "ChargeItemDefinition.derivedFromUri",
"short" : "Underlying externally-defined charge item definition",
"definition" : "The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.partOf",
"path" : "ChargeItemDefinition.partOf",
"short" : "A larger definition of which this particular definition is a component or step",
"definition" : "A larger definition of which this particular definition is a component or step.",
"alias" : ["container"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ChargeItemDefinition"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.replaces",
"path" : "ChargeItemDefinition.replaces",
"short" : "Completed or terminated request(s) whose function is taken by this new request",
"definition" : "As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.",
"alias" : ["supersedes",
"prior",
"renewed order"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ChargeItemDefinition"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.status",
"path" : "ChargeItemDefinition.status",
"short" : "draft | active | retired | unknown",
"definition" : "The current state of the ChargeItemDefinition.",
"comment" : "Allows filtering of charge item definitions that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status {different ValueSet}"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.experimental",
"path" : "ChargeItemDefinition.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of charge item definitions that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level charge item definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.date",
"path" : "ChargeItemDefinition.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the charge item definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the charge item definition changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the charge item definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.publisher",
"path" : "ChargeItemDefinition.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the charge item definition.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the charge item definition is the organization or individual primarily responsible for the maintenance and upkeep of the charge item definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the charge item definition. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the charge item definition. May also allow for contact.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher {as string instead of CodeableConcept}"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.contact",
"path" : "ChargeItemDefinition.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.description",
"path" : "ChargeItemDefinition.description",
"short" : "Natural language description of the charge item definition",
"definition" : "A free text natural language description of the charge item definition from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the charge item definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the charge item definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the charge item definition is presumed to be the predominant language in the place the charge item definition was created).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.useContext",
"path" : "ChargeItemDefinition.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate charge item definition instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.jurisdiction",
"path" : "ChargeItemDefinition.jurisdiction",
"short" : "Intended jurisdiction for charge item definition (if applicable)",
"definition" : "A legal or geographic region in which the charge item definition is intended to be used.",
"comment" : "It may be possible for the charge item definition to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.copyright",
"path" : "ChargeItemDefinition.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the charge item definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the charge item definition.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the charge item definition and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "rim",
"map" : "N/A"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ChargeItemDefinition.approvalDate",
"path" : "ChargeItemDefinition.approvalDate",
"short" : "When the charge item definition was approved by publisher",
"definition" : "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comment" : "The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.approvalDate"
},
{
"identity" : "rim",
"map" : "N/A"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ChargeItemDefinition.lastReviewDate",
"path" : "ChargeItemDefinition.lastReviewDate",
"short" : "When the charge item definition was last reviewed",
"definition" : "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"comment" : "If specified, this date follows the original approval date.",
"requirements" : "Gives a sense of how \"current\" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.lastReviewDate"
},
{
"identity" : "rim",
"map" : "N/A"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ChargeItemDefinition.effectivePeriod",
"path" : "ChargeItemDefinition.effectivePeriod",
"short" : "When the charge item definition is expected to be used",
"definition" : "The period during which the charge item definition content was or is planned to be in active use.",
"comment" : "The effective period for a charge item definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.",
"requirements" : "Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the charge item definition are or are expected to be used instead.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.effectivePeriod"
},
{
"identity" : "rim",
"map" : "N/A"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ChargeItemDefinition.code",
"path" : "ChargeItemDefinition.code",
"short" : "Billing codes or product types this definition applies to",
"definition" : "The defined billing details in this resource pertain to the given billing code.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ChargeItemDefinitionCode"
}],
"strength" : "example",
"description" : "Billing Code defined by this ChargeItemDefinition.",
"valueSet" : "http://hl7.org/fhir/ValueSet/chargeitem-billingcodes"
},
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.instance",
"path" : "ChargeItemDefinition.instance",
"short" : "Instances this definition applies to",
"definition" : "The defined billing details in this resource pertain to the given product instance(s).",
"comment" : "In case of highly customized, individually produced or fitted devices/substances, the pricing information may be different for each instance of the product. This reference links pricing details to specific product instances.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Substance",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.applicability",
"path" : "ChargeItemDefinition.applicability",
"short" : "Whether or not the billing code is applicable",
"definition" : "Expressions that describe applicability criteria for the billing code.",
"comment" : "The applicability conditions can be used to ascertain whether a billing item is allowed in a specific context. E.g. some billing codes may only be applicable in out-patient settings, only to male/female patients or only to children.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.applicability.description",
"path" : "ChargeItemDefinition.applicability.description",
"short" : "Natural language description of the condition",
"definition" : "A brief, natural language description of the condition that effectively communicates the intended semantics.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.applicability.language",
"path" : "ChargeItemDefinition.applicability.language",
"short" : "Language of the expression",
"definition" : "The media type of the language for the expression, e.g. \"text/cql\" for Clinical Query Language expressions or \"text/fhirpath\" for FHIRPath expressions.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.applicability.expression",
"path" : "ChargeItemDefinition.applicability.expression",
"short" : "Boolean-valued expression",
"definition" : "An expression that returns true or false, indicating whether the condition is satisfied. When using FHIRPath expressions, the %context environment variable must be replaced at runtime with the ChargeItem resource to which this definition is applied.",
"comment" : "Please note that FHIRPath Expressions can only be evaluated in the scope of the current ChargeItem resource to which this definition is being applied.\nFHIRPath expressions can traverse into other resources linked from the ChargeItem resource, however, testing rules such as that a billing code may be billed only once per encounter need a wider scope. In such scenarios, CQL may be the appropriate choice.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.propertyGroup",
"path" : "ChargeItemDefinition.propertyGroup",
"short" : "Group of properties which are applicable under the same conditions",
"definition" : "Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.propertyGroup.applicability",
"path" : "ChargeItemDefinition.propertyGroup.applicability",
"short" : "Conditions under which the priceComponent is applicable",
"definition" : "Expressions that describe applicability criteria for the priceComponent.",
"comment" : "The applicability conditions can be used to ascertain whether a billing item is allowed in a specific context. E.g. some billing codes may only be applicable in out-patient settings, only to male/female patients or only to children.",
"min" : 0,
"max" : "*",
"contentReference" : "#ChargeItemDefinition.applicability",
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.propertyGroup.priceComponent",
"path" : "ChargeItemDefinition.propertyGroup.priceComponent",
"short" : "Components of total line item price",
"definition" : "The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the prices have been calculated.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.propertyGroup.priceComponent.type",
"path" : "ChargeItemDefinition.propertyGroup.priceComponent.type",
"short" : "base | surcharge | deduction | discount | tax | informational",
"definition" : "This code identifies the type of the component.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ChargeItemDefinitionPriceComponentType"
}],
"strength" : "required",
"description" : "Codes indicating the kind of the price component.",
"valueSet" : "http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.0"
},
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.propertyGroup.priceComponent.code",
"path" : "ChargeItemDefinition.propertyGroup.priceComponent.code",
"short" : "Code identifying the specific component",
"definition" : "A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.propertyGroup.priceComponent.factor",
"path" : "ChargeItemDefinition.propertyGroup.priceComponent.factor",
"short" : "Factor used for calculating this component",
"definition" : "The factor that has been applied on the base price for calculating this component.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}],
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ChargeItemDefinition.propertyGroup.priceComponent.amount",
"path" : "ChargeItemDefinition.propertyGroup.priceComponent.amount",
"short" : "Monetary amount associated with this component",
"definition" : "The amount calculated for this component.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}],
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/Claim",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "Claim",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints Claim TU DomainResource Claim, Pre-determination or Pre-authorization
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension \r\n identifier 0..* Identifier Business Identifier for claim
\r\n status ?!Σ 1..1 code active | cancelled | draft | entered-in-error
Financial Resource Status Codes (Required) \r\n type Σ 1..1 CodeableConcept Category or discipline
Claim Type Codes (Extensible) \r\n subType 0..1 CodeableConcept More granular claim type
Example Claim SubType Codes (Example) \r\n use Σ 1..1 code claim | preauthorization | predetermination
Use (Required) \r\n patient Σ 1..1 Reference(Patient) The recipient of the products and services \r\n billablePeriod Σ 0..1 Period Relevant time frame for the claim \r\n created Σ 1..1 dateTime Resource creation date \r\n enterer 0..1 Reference(Practitioner | PractitionerRole) Author of the claim \r\n insurer Σ 0..1 Reference(Organization) Target \r\n provider Σ 1..1 Reference(Practitioner | PractitionerRole | Organization) Party responsible for the claim \r\n priority Σ 1..1 CodeableConcept Desired processing ugency
Process Priority Codes (Example) \r\n fundsReserve 0..1 CodeableConcept For whom to reserve funds
FundsReserve (Example) \r\n related 0..* BackboneElement Prior or corollary claims
\r\n claim 0..1 Reference(Claim) Reference to the related claim \r\n relationship 0..1 CodeableConcept How the reference claim is related
Example Related Claim Relationship Codes (Example) \r\n reference 0..1 Identifier File or case reference \r\n prescription 0..1 Reference(DeviceRequest | MedicationRequest | VisionPrescription) Prescription authorizing services and products \r\n originalPrescription 0..1 Reference(DeviceRequest | MedicationRequest | VisionPrescription) Original prescription if superseded by fulfiller \r\n payee 0..1 BackboneElement Recipient of benefits payable \r\n type 1..1 CodeableConcept Category of recipient
PayeeType (Example) \r\n party 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) Recipient reference \r\n referral 0..1 Reference(ServiceRequest) Treatment referral \r\n facility 0..1 Reference(Location) Servicing facility \r\n careTeam 0..* BackboneElement Members of the care team
\r\n sequence 1..1 positiveInt Order of care team \r\n provider 1..1 Reference(Practitioner | PractitionerRole | Organization) Practitioner or organization \r\n responsible 0..1 boolean Indicator of the lead practitioner \r\n role 0..1 CodeableConcept Function within the team
Claim Care Team Role Codes (Example) \r\n qualification 0..1 CodeableConcept Practitioner credential or specialization
Example Provider Qualification Codes (Example) \r\n supportingInfo 0..* BackboneElement Supporting information
\r\n sequence 1..1 positiveInt Information instance identifier \r\n category 1..1 CodeableConcept Classification of the supplied information
Claim Information Category Codes (Example) \r\n code 0..1 CodeableConcept Type of information
Exception Codes (Example) \r\n timing[x] 0..1 When it occurred \r\n timingDate date \r\n timingPeriod Period \r\n value[x] 0..1 Data to be provided \r\n valueBoolean boolean \r\n valueString string \r\n valueQuantity Quantity \r\n valueAttachment Attachment \r\n valueReference Reference(Any) \r\n reason 0..1 CodeableConcept Explanation for the information
Missing Tooth Reason Codes (Example) \r\n diagnosis 0..* BackboneElement Pertinent diagnosis information
\r\n sequence 1..1 positiveInt Diagnosis instance identifier \r\n diagnosis[x] 1..1 Nature of illness or problem
ICD-10 Codes (Example) \r\n diagnosisCodeableConcept CodeableConcept \r\n diagnosisReference Reference(Condition) \r\n type 0..* CodeableConcept Timing or nature of the diagnosis
Example Diagnosis Type Codes (Example)
\r\n onAdmission 0..1 CodeableConcept Present on admission
Example Diagnosis on Admission Codes (Example) \r\n packageCode 0..1 CodeableConcept Package billing code
Example Diagnosis Related Group Codes (Example) \r\n procedure 0..* BackboneElement Clinical procedures performed
\r\n sequence 1..1 positiveInt Procedure instance identifier \r\n type 0..* CodeableConcept Category of Procedure
Example Procedure Type Codes (Example)
\r\n date 0..1 dateTime When the procedure was performed \r\n procedure[x] 1..1 Specific clinical procedure
ICD-10 Procedure Codes (Example) \r\n procedureCodeableConcept CodeableConcept \r\n procedureReference Reference(Procedure) \r\n udi 0..* Reference(Device) Unique device identifier
\r\n insurance Σ 1..* BackboneElement Patient insurance information
\r\n sequence Σ 1..1 positiveInt Insurance instance identifier \r\n focal Σ 1..1 boolean Coverage to be used for adjudication \r\n identifier 0..1 Identifier Pre-assigned Claim number \r\n coverage Σ 1..1 Reference(Coverage) Insurance information \r\n businessArrangement 0..1 string Additional provider contract number \r\n preAuthRef 0..* string Prior authorization reference number
\r\n claimResponse 0..1 Reference(ClaimResponse) Adjudication results \r\n accident 0..1 BackboneElement Details of the event \r\n date 1..1 date When the incident occurred \r\n type 0..1 CodeableConcept The nature of the accident
V3 Value SetActIncidentCode (Extensible) \r\n location[x] 0..1 Where the event occurred \r\n locationAddress Address \r\n locationReference Reference(Location) \r\n item 0..* BackboneElement Product or service provided
\r\n sequence 1..1 positiveInt Item instance identifier \r\n careTeamSequence 0..* positiveInt Applicable careTeam members
\r\n diagnosisSequence 0..* positiveInt Applicable diagnoses
\r\n procedureSequence 0..* positiveInt Applicable procedures
\r\n informationSequence 0..* positiveInt Applicable exception and supporting information
\r\n revenue 0..1 CodeableConcept Revenue or cost center code
Example Revenue Center Codes (Example) \r\n category 0..1 CodeableConcept Benefit classification
Benefit Category Codes (Example) \r\n productOrService 1..1 CodeableConcept Billing, service, product, or drug code
USCLS Codes (Example) \r\n modifier 0..* CodeableConcept Product or service billing modifiers
Modifier type Codes (Example)
\r\n programCode 0..* CodeableConcept Program the product or service is provided under
Example Program Reason Codes (Example)
\r\n serviced[x] 0..1 Date or dates of service or product delivery \r\n servicedDate date \r\n servicedPeriod Period \r\n location[x] 0..1 Place of service or where product was supplied
Example Service Place Codes (Example) \r\n locationCodeableConcept CodeableConcept \r\n locationAddress Address \r\n locationReference Reference(Location) \r\n quantity 0..1 SimpleQuantity Count of products or services \r\n unitPrice 0..1 Money Fee, charge or cost per item \r\n factor 0..1 decimal Price scaling factor \r\n net 0..1 Money Total item cost \r\n udi 0..* Reference(Device) Unique device identifier
\r\n bodySite 0..1 CodeableConcept Anatomical location
Oral Site Codes (Example) \r\n subSite 0..* CodeableConcept Anatomical sub-location
Surface Codes (Example)
\r\n encounter 0..* Reference(Encounter) Encounters related to this billed item
\r\n detail 0..* BackboneElement Product or service provided
\r\n sequence 1..1 positiveInt Item instance identifier \r\n revenue 0..1 CodeableConcept Revenue or cost center code
Example Revenue Center Codes (Example) \r\n category 0..1 CodeableConcept Benefit classification
Benefit Category Codes (Example) \r\n productOrService 1..1 CodeableConcept Billing, service, product, or drug code
USCLS Codes (Example) \r\n modifier 0..* CodeableConcept Service/Product billing modifiers
Modifier type Codes (Example)
\r\n programCode 0..* CodeableConcept Program the product or service is provided under
Example Program Reason Codes (Example)
\r\n quantity 0..1 SimpleQuantity Count of products or services \r\n unitPrice 0..1 Money Fee, charge or cost per item \r\n factor 0..1 decimal Price scaling factor \r\n net 0..1 Money Total item cost \r\n udi 0..* Reference(Device) Unique device identifier
\r\n subDetail 0..* BackboneElement Product or service provided
\r\n sequence 1..1 positiveInt Item instance identifier \r\n revenue 0..1 CodeableConcept Revenue or cost center code
Example Revenue Center Codes (Example) \r\n category 0..1 CodeableConcept Benefit classification
Benefit Category Codes (Example) \r\n productOrService 1..1 CodeableConcept Billing, service, product, or drug code
USCLS Codes (Example) \r\n modifier 0..* CodeableConcept Service/Product billing modifiers
Modifier type Codes (Example)
\r\n programCode 0..* CodeableConcept Program the product or service is provided under
Example Program Reason Codes (Example)
\r\n quantity 0..1 SimpleQuantity Count of products or services \r\n unitPrice 0..1 Money Fee, charge or cost per item \r\n factor 0..1 decimal Price scaling factor \r\n net 0..1 Money Total item cost \r\n udi 0..* Reference(Device) Unique device identifier
\r\n total 0..1 Money Total claim cost \r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Financial.Billing"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fm"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Claim",
"version" : "4.0.0",
"name" : "Claim",
"status" : "draft",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (Financial Management)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fm/index.cfm"
}]
}],
"description" : "A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.",
"purpose" : "The Claim resource is used by providers to exchange services and products rendered to patients or planned to be rendered with insurers for reimbuserment. It is also used by insurers to exchange claims information with statutory reporting and data analytics firms.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Claim",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Claim",
"path" : "Claim",
"short" : "Claim, Pre-determination or Pre-authorization",
"definition" : "A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.",
"comment" : "The Claim resource fulfills three information request requirements: Claim - a request for adjudication for reimbursement for products and/or services provided; Preauthorization - a request to authorize the future provision of products and/or services including an anticipated adjudication; and, Predetermination - a request for a non-bind adjudication of possible future products and/or services.",
"alias" : ["Adjudication Request",
"Preauthorization Request",
"Predetermination Request"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Request"
}]
},
{
"id" : "Claim.id",
"path" : "Claim.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Claim.meta",
"path" : "Claim.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Claim.implicitRules",
"path" : "Claim.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Claim.language",
"path" : "Claim.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Claim.text",
"path" : "Claim.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Claim.contained",
"path" : "Claim.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.extension",
"path" : "Claim.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.modifierExtension",
"path" : "Claim.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.identifier",
"path" : "Claim.identifier",
"short" : "Business Identifier for claim",
"definition" : "A unique identifier assigned to this claim.",
"requirements" : "Allows claims to be distinguished and referenced.",
"alias" : ["Claim Number"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "Claim.status",
"path" : "Claim.status",
"short" : "active | cancelled | draft | entered-in-error",
"definition" : "The status of the resource instance.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"requirements" : "Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClaimStatus"
}],
"strength" : "required",
"description" : "A code specifying the state of the resource instance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/fm-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "Claim.type",
"path" : "Claim.type",
"short" : "Category or discipline",
"definition" : "The category of claim, e.g. oral, pharmacy, vision, institutional, professional.",
"comment" : "The majority of jurisdictions use: oral, pharmacy, vision, professional and institutional, or variants on those terms, as the general styles of claims. The valueset is extensible to accommodate other jurisdictional requirements.",
"requirements" : "Claim type determine the general sets of business rules applied for information requirements and adjudication.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClaimType"
}],
"strength" : "extensible",
"description" : "The type or discipline-style of the claim.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Claim.subType",
"path" : "Claim.subType",
"short" : "More granular claim type",
"definition" : "A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.",
"comment" : "This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type.",
"requirements" : "Some jurisdictions need a finer grained claim type for routing and adjudication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.subType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClaimSubType"
}],
"strength" : "example",
"description" : "A more granular claim typecode.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-subtype"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Claim.use",
"path" : "Claim.use",
"short" : "claim | preauthorization | predetermination",
"definition" : "A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.",
"requirements" : "This element is required to understand the nature of the request for adjudication.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.use",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Use"
}],
"strength" : "required",
"description" : "The purpose of the Claim: predetermination, preauthorization, claim.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-use|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Claim.patient",
"path" : "Claim.patient",
"short" : "The recipient of the products and services",
"definition" : "The party to whom the professional services and/or products have been supplied or are being considered and for whom actual or forecast reimbursement is sought.",
"requirements" : "The patient must be supplied to the insurer so that confirmation of coverage and service history may be considered as part of the authorization and/or adjudiction.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.patient",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Claim.billablePeriod",
"path" : "Claim.billablePeriod",
"short" : "Relevant time frame for the claim",
"definition" : "The period for which charges are being submitted.",
"comment" : "Typically this would be today or in the past for a claim, and today or in the future for preauthorizations and predeterminations. Typically line item dates of service should fall within the billing period if one is specified.",
"requirements" : "A number jurisdictions required the submission of the billing period when submitting claims for example for hospital stays or long-term care.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.billablePeriod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
}]
},
{
"id" : "Claim.created",
"path" : "Claim.created",
"short" : "Resource creation date",
"definition" : "The date this resource was created.",
"comment" : "This field is independent of the date of creation of the resource as it may reflect the creation date of a source document prior to digitization. Typically for claims all services must be completed as of this date.",
"requirements" : "Need to record a timestamp for use by both the recipient and the issuer.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.created",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.authoredOn"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "Claim.enterer",
"path" : "Claim.enterer",
"short" : "Author of the claim",
"definition" : "Individual who created the claim, predetermination or preauthorization.",
"requirements" : "Some jurisdictions require the contact information for personnel completing claims.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.enterer",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.author"
}]
},
{
"id" : "Claim.insurer",
"path" : "Claim.insurer",
"short" : "Target",
"definition" : "The Insurer who is target of the request.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.insurer",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performer"
}]
},
{
"id" : "Claim.provider",
"path" : "Claim.provider",
"short" : "Party responsible for the claim",
"definition" : "The provider which is responsible for the claim, predetermination or preauthorization.",
"comment" : "Typically this field would be 1..1 where this party is responsible for the claim but not necessarily professionally responsible for the provision of the individual products and services listed below.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.provider",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.requester"
},
{
"identity" : "w5",
"map" : "FiveWs.source"
}]
},
{
"id" : "Claim.priority",
"path" : "Claim.priority",
"short" : "Desired processing ugency",
"definition" : "The provider-required urgency of processing the request. Typical values include: stat, routine deferred.",
"comment" : "If a claim processor is unable to complete the processing as per the priority then they should generate and error and not process the request.",
"requirements" : "The provider may need to indicate their processing requirements so that the processor can indicate if they are unable to comply.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.priority",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcessPriority"
}],
"strength" : "example",
"description" : "The timeliness with which processing is required: stat, normal, deferred.",
"valueSet" : "http://hl7.org/fhir/ValueSet/process-priority"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.priority"
}]
},
{
"id" : "Claim.fundsReserve",
"path" : "Claim.fundsReserve",
"short" : "For whom to reserve funds",
"definition" : "A code to indicate whether and for whom funds are to be reserved for future claims.",
"comment" : "This field is only used for preauthorizations.",
"requirements" : "In the case of a Pre-Determination/Pre-Authorization the provider may request that funds in the amount of the expected Benefit be reserved ('Patient' or 'Provider') to pay for the Benefits determined on the subsequent claim(s). 'None' explicitly indicates no funds reserving is requested.",
"alias" : ["Fund pre-allocation"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.fundsReserve",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FundsReserve"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "example",
"description" : "For whom funds are to be reserved: (Patient, Provider, None).",
"valueSet" : "http://hl7.org/fhir/ValueSet/fundsreserve"
}
},
{
"id" : "Claim.related",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "RelatedClaim"
}],
"path" : "Claim.related",
"short" : "Prior or corollary claims",
"definition" : "Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.",
"comment" : "For example, for the original treatment and follow-up exams.",
"requirements" : "For workplace or other accidents it is common to relate separate claims arising from the same event.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.related",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.related.id",
"path" : "Claim.related.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.related.extension",
"path" : "Claim.related.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.related.modifierExtension",
"path" : "Claim.related.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.related.claim",
"path" : "Claim.related.claim",
"short" : "Reference to the related claim",
"definition" : "Reference to a related claim.",
"requirements" : "For workplace or other accidents it is common to relate separate claims arising from the same event.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.related.claim",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Claim"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.replaces"
}]
},
{
"id" : "Claim.related.relationship",
"path" : "Claim.related.relationship",
"short" : "How the reference claim is related",
"definition" : "A code to convey how the claims are related.",
"comment" : "For example, prior claim or umbrella.",
"requirements" : "Some insurers need a declaration of the type of relationship.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.related.relationship",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RelatedClaimRelationship"
}],
"strength" : "example",
"description" : "Relationship of this claim to a related Claim.",
"valueSet" : "http://hl7.org/fhir/ValueSet/related-claim-relationship"
}
},
{
"id" : "Claim.related.reference",
"path" : "Claim.related.reference",
"short" : "File or case reference",
"definition" : "An alternate organizational reference to the case or file to which this particular claim pertains.",
"comment" : "For example, Property/Casualty insurer claim # or Workers Compensation case # .",
"requirements" : "In cases where an event-triggered claim is being submitted to an insurer which requires a reference number to be specified on all exchanges.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.related.reference",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.prescription",
"path" : "Claim.prescription",
"short" : "Prescription authorizing services and products",
"definition" : "Prescription to support the dispensing of pharmacy, device or vision products.",
"requirements" : "Required to authorize the dispensing of controlled substances and devices.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.prescription",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DeviceRequest",
"http://hl7.org/fhir/StructureDefinition/MedicationRequest",
"http://hl7.org/fhir/StructureDefinition/VisionPrescription"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.originalPrescription",
"path" : "Claim.originalPrescription",
"short" : "Original prescription if superseded by fulfiller",
"definition" : "Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.",
"comment" : "For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefore issues a new prescription for an alternate medication which has the same therapeutic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'.",
"requirements" : "Often required when a fulfiller varies what is fulfilled from that authorized on the original prescription.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.originalPrescription",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DeviceRequest",
"http://hl7.org/fhir/StructureDefinition/MedicationRequest",
"http://hl7.org/fhir/StructureDefinition/VisionPrescription"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.payee",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Payee"
}],
"path" : "Claim.payee",
"short" : "Recipient of benefits payable",
"definition" : "The party to be reimbursed for cost of the products and services according to the terms of the policy.",
"comment" : "Often providers agree to receive the benefits payable to reduce the near-term costs to the patient. The insurer may decline to pay the provider and choose to pay the subscriber instead.",
"requirements" : "The provider needs to specify who they wish to be reimbursed and the claims processor needs express who they will reimburse.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.payee",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.payee.id",
"path" : "Claim.payee.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.payee.extension",
"path" : "Claim.payee.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.payee.modifierExtension",
"path" : "Claim.payee.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.payee.type",
"path" : "Claim.payee.type",
"short" : "Category of recipient",
"definition" : "Type of Party to be reimbursed: subscriber, provider, other.",
"requirements" : "Need to know who should receive payment with the most common situations being the Provider (assignment of benefits) or the Subscriber.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.payee.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PayeeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "example",
"description" : "A code for the party to be reimbursed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/payeetype"
}
},
{
"id" : "Claim.payee.party",
"path" : "Claim.payee.party",
"short" : "Recipient reference",
"definition" : "Reference to the individual or organization to whom any payment will be made.",
"comment" : "Not required if the payee is 'subscriber' or 'provider'.",
"requirements" : "Need to provide demographics if the payee is not 'subscriber' nor 'provider'.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.payee.party",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.referral",
"path" : "Claim.referral",
"short" : "Treatment referral",
"definition" : "A reference to a referral resource.",
"comment" : "The referral resource which lists the date, practitioner, reason and other supporting information.",
"requirements" : "Some insurers require proof of referral to pay for services or to pay specialist rates for services.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.referral",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ServiceRequest"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.cause"
}]
},
{
"id" : "Claim.facility",
"path" : "Claim.facility",
"short" : "Servicing facility",
"definition" : "Facility where the services were provided.",
"requirements" : "Insurance adjudication can be dependant on where services were delivered.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.facility",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.where[x]"
}]
},
{
"id" : "Claim.careTeam",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "CareTeam"
}],
"path" : "Claim.careTeam",
"short" : "Members of the care team",
"definition" : "The members of the team who provided the products and services.",
"requirements" : "Common to identify the responsible and supporting practitioners.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.careTeam",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.careTeam.id",
"path" : "Claim.careTeam.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.careTeam.extension",
"path" : "Claim.careTeam.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.careTeam.modifierExtension",
"path" : "Claim.careTeam.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.careTeam.sequence",
"path" : "Claim.careTeam.sequence",
"short" : "Order of care team",
"definition" : "A number to uniquely identify care team entries.",
"requirements" : "Necessary to maintain the order of the care team and provide a mechanism to link individuals to claim details.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.careTeam.sequence",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.careTeam.provider",
"path" : "Claim.careTeam.provider",
"short" : "Practitioner or organization",
"definition" : "Member of the team who provided the product or service.",
"requirements" : "Often a regulatory requirement to specify the responsible provider.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.careTeam.provider",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.actor"
}]
},
{
"id" : "Claim.careTeam.responsible",
"path" : "Claim.careTeam.responsible",
"short" : "Indicator of the lead practitioner",
"definition" : "The party who is billing and/or responsible for the claimed products or services.",
"comment" : "Responsible might not be required when there is only a single provider listed.",
"requirements" : "When multiple parties are present it is required to distinguish the lead or responsible individual.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.careTeam.responsible",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.careTeam.role",
"path" : "Claim.careTeam.role",
"short" : "Function within the team",
"definition" : "The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team.",
"comment" : "Role might not be required when there is only a single provider listed.",
"requirements" : "When multiple parties are present it is required to distinguish the roles performed by each member.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.careTeam.role",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CareTeamRole"
}],
"strength" : "example",
"description" : "The role codes for the care team members.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-careteamrole"
}
},
{
"id" : "Claim.careTeam.qualification",
"path" : "Claim.careTeam.qualification",
"short" : "Practitioner credential or specialization",
"definition" : "The qualification of the practitioner which is applicable for this service.",
"requirements" : "Need to specify which qualification a provider is delivering the product or service under.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.careTeam.qualification",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProviderQualification"
}],
"strength" : "example",
"description" : "Provider professional qualifications.",
"valueSet" : "http://hl7.org/fhir/ValueSet/provider-qualification"
}
},
{
"id" : "Claim.supportingInfo",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "SupportingInformation"
}],
"path" : "Claim.supportingInfo",
"short" : "Supporting information",
"definition" : "Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.",
"comment" : "Often there are multiple jurisdiction specific valuesets which are required.",
"requirements" : "Typically these information codes are required to support the services rendered or the adjudication of the services rendered.",
"alias" : ["Attachments\nException Codes\nOccurrence Codes\nValue codes"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.supportingInfo",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.supportingInfo"
}]
},
{
"id" : "Claim.supportingInfo.id",
"path" : "Claim.supportingInfo.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.supportingInfo.extension",
"path" : "Claim.supportingInfo.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.supportingInfo.modifierExtension",
"path" : "Claim.supportingInfo.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.supportingInfo.sequence",
"path" : "Claim.supportingInfo.sequence",
"short" : "Information instance identifier",
"definition" : "A number to uniquely identify supporting information entries.",
"requirements" : "Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.supportingInfo.sequence",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.supportingInfo.category",
"path" : "Claim.supportingInfo.category",
"short" : "Classification of the supplied information",
"definition" : "The general class of the information supplied: information; exception; accident, employment; onset, etc.",
"comment" : "This may contain a category for the local bill type codes.",
"requirements" : "Required to group or associate information items with common characteristics. For example: admission information or prior treatments.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.supportingInfo.category",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "InformationCategory"
}],
"strength" : "example",
"description" : "The valuset used for additional information category codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-informationcategory"
}
},
{
"id" : "Claim.supportingInfo.code",
"path" : "Claim.supportingInfo.code",
"short" : "Type of information",
"definition" : "System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.",
"requirements" : "Required to identify the kind of additional information.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.supportingInfo.code",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "InformationCode"
}],
"strength" : "example",
"description" : "The valuset used for additional information codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-exception"
}
},
{
"id" : "Claim.supportingInfo.timing[x]",
"path" : "Claim.supportingInfo.timing[x]",
"short" : "When it occurred",
"definition" : "The date when or period to which this information refers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.supportingInfo.timing[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
},
{
"code" : "Period"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.supportingInfo.value[x]",
"path" : "Claim.supportingInfo.value[x]",
"short" : "Data to be provided",
"definition" : "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.",
"comment" : "Could be used to provide references to other resources, document. For example could contain a PDF in an Attachment of the Police Report for an Accident.",
"requirements" : "To convey the data content to be provided when the information is more than a simple code or period.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.supportingInfo.value[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
},
{
"code" : "string"
},
{
"code" : "Quantity"
},
{
"code" : "Attachment"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.supportingInfo.reason",
"path" : "Claim.supportingInfo.reason",
"short" : "Explanation for the information",
"definition" : "Provides the reason in the situation where a reason code is required in addition to the content.",
"comment" : "For example: the reason for the additional stay, or why a tooth is missing.",
"requirements" : "Needed when the supporting information has both a date and amount/value and requires explanation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.supportingInfo.reason",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MissingReason"
}],
"strength" : "example",
"description" : "Reason codes for the missing teeth.",
"valueSet" : "http://hl7.org/fhir/ValueSet/missing-tooth-reason"
}
},
{
"id" : "Claim.diagnosis",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Diagnosis"
}],
"path" : "Claim.diagnosis",
"short" : "Pertinent diagnosis information",
"definition" : "Information about diagnoses relevant to the claim items.",
"requirements" : "Required for the adjudication by provided context for the services and product listed.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.diagnosis",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonReference"
}]
},
{
"id" : "Claim.diagnosis.id",
"path" : "Claim.diagnosis.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.diagnosis.extension",
"path" : "Claim.diagnosis.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.diagnosis.modifierExtension",
"path" : "Claim.diagnosis.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.diagnosis.sequence",
"path" : "Claim.diagnosis.sequence",
"short" : "Diagnosis instance identifier",
"definition" : "A number to uniquely identify diagnosis entries.",
"comment" : "Diagnosis are presented in list order to their expected importance: primary, secondary, etc.",
"requirements" : "Necessary to maintain the order of the diagnosis items and provide a mechanism to link to claim details.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.diagnosis.sequence",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.diagnosis.diagnosis[x]",
"path" : "Claim.diagnosis.diagnosis[x]",
"short" : "Nature of illness or problem",
"definition" : "The nature of illness or problem in a coded form or as a reference to an external defined Condition.",
"requirements" : "Provides health context for the evaluation of the products and/or services.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.diagnosis.diagnosis[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition"]
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ICD10"
}],
"strength" : "example",
"description" : "Example ICD10 Diagnostic codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/icd-10"
}
},
{
"id" : "Claim.diagnosis.type",
"path" : "Claim.diagnosis.type",
"short" : "Timing or nature of the diagnosis",
"definition" : "When the condition was observed or the relative ranking.",
"comment" : "For example: admitting, primary, secondary, discharge.",
"requirements" : "Often required to capture a particular diagnosis, for example: primary or discharge.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.diagnosis.type",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DiagnosisType"
}],
"strength" : "example",
"description" : "The type of the diagnosis: admitting, principal, discharge.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-diagnosistype"
}
},
{
"id" : "Claim.diagnosis.onAdmission",
"path" : "Claim.diagnosis.onAdmission",
"short" : "Present on admission",
"definition" : "Indication of whether the diagnosis was present on admission to a facility.",
"requirements" : "Many systems need to understand for adjudication if the diagnosis was present a time of admission.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.diagnosis.onAdmission",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DiagnosisOnAdmission"
}],
"strength" : "example",
"description" : "Present on admission.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-diagnosis-on-admission"
}
},
{
"id" : "Claim.diagnosis.packageCode",
"path" : "Claim.diagnosis.packageCode",
"short" : "Package billing code",
"definition" : "A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.",
"comment" : "For example DRG (Diagnosis Related Group) or a bundled billing code. A patient may have a diagnosis of a Myocardial Infarction and a DRG for HeartAttack would be assigned. The Claim item (and possible subsequent claims) would refer to the DRG for those line items that were for services related to the heart attack event.",
"requirements" : "Required to relate the current diagnosis to a package billing code that is then referenced on the individual claim items which are specific to the health condition covered by the package code.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.diagnosis.packageCode",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DiagnosisRelatedGroup"
}],
"strength" : "example",
"description" : "The DRG codes associated with the diagnosis.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-diagnosisrelatedgroup"
}
},
{
"id" : "Claim.procedure",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Procedure"
}],
"path" : "Claim.procedure",
"short" : "Clinical procedures performed",
"definition" : "Procedures performed on the patient relevant to the billing items with the claim.",
"requirements" : "The specific clinical invention are sometimes required to be provided to justify billing a greater than customary amount for a service.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.procedure",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.procedure.id",
"path" : "Claim.procedure.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.procedure.extension",
"path" : "Claim.procedure.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.procedure.modifierExtension",
"path" : "Claim.procedure.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.procedure.sequence",
"path" : "Claim.procedure.sequence",
"short" : "Procedure instance identifier",
"definition" : "A number to uniquely identify procedure entries.",
"requirements" : "Necessary to provide a mechanism to link to claim details.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.procedure.sequence",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.procedure.type",
"path" : "Claim.procedure.type",
"short" : "Category of Procedure",
"definition" : "When the condition was observed or the relative ranking.",
"comment" : "For example: primary, secondary.",
"requirements" : "Often required to capture a particular diagnosis, for example: primary or discharge.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.procedure.type",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedureType"
}],
"strength" : "example",
"description" : "Example procedure type codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-procedure-type"
}
},
{
"id" : "Claim.procedure.date",
"path" : "Claim.procedure.date",
"short" : "When the procedure was performed",
"definition" : "Date and optionally time the procedure was performed.",
"requirements" : "Required for auditing purposes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.procedure.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.procedure.procedure[x]",
"path" : "Claim.procedure.procedure[x]",
"short" : "Specific clinical procedure",
"definition" : "The code or reference to a Procedure resource which identifies the clinical intervention performed.",
"requirements" : "This identifies the actual clinical procedure.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.procedure.procedure[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Procedure"]
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ICD10_Procedures"
}],
"strength" : "example",
"description" : "Example ICD10 Procedure codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/icd-10-procedures"
}
},
{
"id" : "Claim.procedure.udi",
"path" : "Claim.procedure.udi",
"short" : "Unique device identifier",
"definition" : "Unique Device Identifiers associated with this line item.",
"requirements" : "The UDI code allows the insurer to obtain device level information on the product supplied.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.procedure.udi",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.insurance",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Insurance"
}],
"path" : "Claim.insurance",
"short" : "Patient insurance information",
"definition" : "Financial instruments for reimbursement for the health care products and services specified on the claim.",
"comment" : "All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'Coverage.subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.",
"requirements" : "At least one insurer is required for a claim to be a claim.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Claim.insurance",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "Coverage"
}]
},
{
"id" : "Claim.insurance.id",
"path" : "Claim.insurance.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.insurance.extension",
"path" : "Claim.insurance.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.insurance.modifierExtension",
"path" : "Claim.insurance.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.insurance.sequence",
"path" : "Claim.insurance.sequence",
"short" : "Insurance instance identifier",
"definition" : "A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.",
"requirements" : "To maintain order of the coverages.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.insurance.sequence",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Claim.insurance.focal",
"path" : "Claim.insurance.focal",
"short" : "Coverage to be used for adjudication",
"definition" : "A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.",
"comment" : "A patient may (will) have multiple insurance policies which provide reimbursement for healthcare services and products. For example a person may also be covered by their spouse's policy and both appear in the list (and may be from the same insurer). This flag will be set to true for only one of the listed policies and that policy will be used for adjudicating this claim. Other claims would be created to request adjudication against the other listed policies.",
"requirements" : "To identify which coverage in the list is being used to adjudicate this claim.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.insurance.focal",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Claim.insurance.identifier",
"path" : "Claim.insurance.identifier",
"short" : "Pre-assigned Claim number",
"definition" : "The business identifier to be used when the claim is sent for adjudication against this insurance policy.",
"comment" : "Only required in jurisdictions where insurers, rather than the provider, are required to send claims to insurers that appear after them in the list. This element is not required when 'subrogation=true'.",
"requirements" : "This will be the claim number should it be necessary to create this claim in the future. This is provided so that payors may forward claims to other payors in the Coordination of Benefit for adjudication rather than the provider being required to initiate each adjudication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.insurance.identifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "Claim.insurance.coverage",
"path" : "Claim.insurance.coverage",
"short" : "Insurance information",
"definition" : "Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.",
"requirements" : "Required to allow the adjudicator to locate the correct policy and history within their information system.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.insurance.coverage",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Coverage"]
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Claim.insurance.businessArrangement",
"path" : "Claim.insurance.businessArrangement",
"short" : "Additional provider contract number",
"definition" : "A business agreement number established between the provider and the insurer for special business processing purposes.",
"requirements" : "Providers may have multiple business arrangements with a given insurer and must supply the specific contract number for adjudication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.insurance.businessArrangement",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.insurance.preAuthRef",
"path" : "Claim.insurance.preAuthRef",
"short" : "Prior authorization reference number",
"definition" : "Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization.",
"comment" : "This value is an alphanumeric string that may be provided over the phone, via text, via paper, or within a ClaimResponse resource and is not a FHIR Identifier.",
"requirements" : "Providers must quote previously issued authorization reference numbers in order to obtain adjudication as previously advised on the Preauthorization.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.insurance.preAuthRef",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.insurance.claimResponse",
"path" : "Claim.insurance.claimResponse",
"short" : "Adjudication results",
"definition" : "The result of the adjudication of the line items for the Coverage specified in this insurance.",
"comment" : "Must not be specified when 'focal=true' for this insurance.",
"requirements" : "An insurer need the adjudication results from prior insurers to determine the outstanding balance remaining by item for the items in the curent claim.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.insurance.claimResponse",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ClaimResponse"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.accident",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Accident"
}],
"path" : "Claim.accident",
"short" : "Details of the event",
"definition" : "Details of an accident which resulted in injuries which required the products and services listed in the claim.",
"requirements" : "When healthcare products and services are accident related, benefits may be payable under accident provisions of policies, such as automotive, etc before they are payable under normal health insurance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.accident",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.accident.id",
"path" : "Claim.accident.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.accident.extension",
"path" : "Claim.accident.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.accident.modifierExtension",
"path" : "Claim.accident.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.accident.date",
"path" : "Claim.accident.date",
"short" : "When the incident occurred",
"definition" : "Date of an accident event related to the products and services contained in the claim.",
"comment" : "The date of the accident has to precede the dates of the products and services but within a reasonable timeframe.",
"requirements" : "Required for audit purposes and adjudication.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.accident.date",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.accident.type",
"path" : "Claim.accident.type",
"short" : "The nature of the accident",
"definition" : "The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers.",
"requirements" : "Coverage may be dependant on the type of accident.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.accident.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AccidentType"
}],
"strength" : "extensible",
"description" : "Type of accident: work place, auto, etc.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActIncidentCode"
}
},
{
"id" : "Claim.accident.location[x]",
"path" : "Claim.accident.location[x]",
"short" : "Where the event occurred",
"definition" : "The physical location of the accident event.",
"requirements" : "Required for audit purposes and determination of applicable insurance liability.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.accident.location[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Address"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Item"
}],
"path" : "Claim.item",
"short" : "Product or service provided",
"definition" : "A claim line. Either a simple product or service or a 'group' of details which can each be a simple items or groups of sub-details.",
"requirements" : "The items to be processed for adjudication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.id",
"path" : "Claim.item.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.item.extension",
"path" : "Claim.item.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.item.modifierExtension",
"path" : "Claim.item.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.item.sequence",
"path" : "Claim.item.sequence",
"short" : "Item instance identifier",
"definition" : "A number to uniquely identify item entries.",
"requirements" : "Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.item.sequence",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.careTeamSequence",
"path" : "Claim.item.careTeamSequence",
"short" : "Applicable careTeam members",
"definition" : "CareTeam members related to this service or product.",
"requirements" : "Need to identify the individuals and their roles in the provision of the product or service.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.careTeamSequence",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.diagnosisSequence",
"path" : "Claim.item.diagnosisSequence",
"short" : "Applicable diagnoses",
"definition" : "Diagnosis applicable for this service or product.",
"requirements" : "Need to related the product or service to the associated diagnoses.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.diagnosisSequence",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.procedureSequence",
"path" : "Claim.item.procedureSequence",
"short" : "Applicable procedures",
"definition" : "Procedures applicable for this service or product.",
"requirements" : "Need to provide any listed specific procedures to support the product or service being claimed.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.procedureSequence",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.informationSequence",
"path" : "Claim.item.informationSequence",
"short" : "Applicable exception and supporting information",
"definition" : "Exceptions, special conditions and supporting information applicable for this service or product.",
"requirements" : "Need to reference the supporting information items that relate directly to this product or service.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.informationSequence",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.revenue",
"path" : "Claim.item.revenue",
"short" : "Revenue or cost center code",
"definition" : "The type of revenue or cost center providing the product and/or service.",
"requirements" : "Needed in the processing of institutional claims.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.revenue",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RevenueCenter"
}],
"strength" : "example",
"description" : "Codes for the revenue or cost centers supplying the service and/or products.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-revenue-center"
}
},
{
"id" : "Claim.item.category",
"path" : "Claim.item.category",
"short" : "Benefit classification",
"definition" : "Code to identify the general type of benefits under which products and services are provided.",
"comment" : "Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.",
"requirements" : "Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.category",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BenefitCategory"
}],
"strength" : "example",
"description" : "Benefit categories such as: oral-basic, major, glasses.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-benefitcategory"
}
},
{
"id" : "Claim.item.productOrService",
"path" : "Claim.item.productOrService",
"short" : "Billing, service, product, or drug code",
"definition" : "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.",
"comment" : "If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.",
"requirements" : "Necessary to state what was provided or done.",
"alias" : ["Drug Code",
"Bill Code",
"Service Code"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.item.productOrService",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceProduct"
}],
"strength" : "example",
"description" : "Allowable service and product codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-uscls"
}
},
{
"id" : "Claim.item.modifier",
"path" : "Claim.item.modifier",
"short" : "Product or service billing modifiers",
"definition" : "Item typification or modifiers codes to convey additional context for the product or service.",
"comment" : "For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours.",
"requirements" : "To support inclusion of the item for adjudication or to charge an elevated fee.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.modifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Modifiers"
}],
"strength" : "example",
"description" : "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-modifiers"
}
},
{
"id" : "Claim.item.programCode",
"path" : "Claim.item.programCode",
"short" : "Program the product or service is provided under",
"definition" : "Identifies the program under which this may be recovered.",
"comment" : "For example: Neonatal program, child dental program or drug users recovery program.",
"requirements" : "Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.programCode",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProgramCode"
}],
"strength" : "example",
"description" : "Program specific reason codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-program-code"
}
},
{
"id" : "Claim.item.serviced[x]",
"path" : "Claim.item.serviced[x]",
"short" : "Date or dates of service or product delivery",
"definition" : "The date or dates when the service or product was supplied, performed or completed.",
"requirements" : "Needed to determine whether the service or product was provided during the term of the insurance coverage.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.serviced[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
},
{
"code" : "Period"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
}]
},
{
"id" : "Claim.item.location[x]",
"path" : "Claim.item.location[x]",
"short" : "Place of service or where product was supplied",
"definition" : "Where the product or service was provided.",
"requirements" : "The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.location[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Address"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServicePlace"
}],
"strength" : "example",
"description" : "Place of service: pharmacy, school, prison, etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-place"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.where[x]"
}]
},
{
"id" : "Claim.item.quantity",
"path" : "Claim.item.quantity",
"short" : "Count of products or services",
"definition" : "The number of repetitions of a service or product.",
"requirements" : "Required when the product or service code does not convey the quantity provided.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.unitPrice",
"path" : "Claim.item.unitPrice",
"short" : "Fee, charge or cost per item",
"definition" : "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.",
"requirements" : "The amount charged to the patient by the provider for a single unit.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.unitPrice",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Money"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.factor",
"path" : "Claim.item.factor",
"short" : "Price scaling factor",
"definition" : "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"comment" : "To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).",
"requirements" : "When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.factor",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.net",
"path" : "Claim.item.net",
"short" : "Total item cost",
"definition" : "The quantity times the unit price for an additional service or product or charge.",
"comment" : "For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.",
"requirements" : "Provides the total amount claimed for the group (if a grouper) or the line item.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.net",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Money"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.udi",
"path" : "Claim.item.udi",
"short" : "Unique device identifier",
"definition" : "Unique Device Identifiers associated with this line item.",
"requirements" : "The UDI code allows the insurer to obtain device level information on the product supplied.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.udi",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.bodySite",
"path" : "Claim.item.bodySite",
"short" : "Anatomical location",
"definition" : "Physical service site on the patient (limb, tooth, etc.).",
"comment" : "For example: Providing a tooth code, allows an insurer to identify a provider performing a filling on a tooth that was previously removed.",
"requirements" : "Allows insurer to validate specific procedures.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.bodySite",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "OralSites"
}],
"strength" : "example",
"description" : "The code for the teeth, quadrant, sextant and arch.",
"valueSet" : "http://hl7.org/fhir/ValueSet/tooth"
}
},
{
"id" : "Claim.item.subSite",
"path" : "Claim.item.subSite",
"short" : "Anatomical sub-location",
"definition" : "A region or surface of the bodySite, e.g. limb region or tooth surface(s).",
"requirements" : "Allows insurer to validate specific procedures.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.subSite",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Surface"
}],
"strength" : "example",
"description" : "The code for the tooth surface and surface combinations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/surface"
}
},
{
"id" : "Claim.item.encounter",
"path" : "Claim.item.encounter",
"short" : "Encounters related to this billed item",
"definition" : "The Encounters during which this Claim was created or to which the creation of this record is tightly associated.",
"comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.",
"requirements" : "Used in some jurisdictions to link clinical events to claim items.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.encounter",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.context"
}]
},
{
"id" : "Claim.item.detail",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Detail"
}],
"path" : "Claim.item.detail",
"short" : "Product or service provided",
"definition" : "A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.",
"requirements" : "The items to be processed for adjudication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.detail",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.id",
"path" : "Claim.item.detail.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.item.detail.extension",
"path" : "Claim.item.detail.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.item.detail.modifierExtension",
"path" : "Claim.item.detail.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.item.detail.sequence",
"path" : "Claim.item.detail.sequence",
"short" : "Item instance identifier",
"definition" : "A number to uniquely identify item entries.",
"requirements" : "Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.sequence",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.revenue",
"path" : "Claim.item.detail.revenue",
"short" : "Revenue or cost center code",
"definition" : "The type of revenue or cost center providing the product and/or service.",
"requirements" : "Needed in the processing of institutional claims.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.revenue",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RevenueCenter"
}],
"strength" : "example",
"description" : "Codes for the revenue or cost centers supplying the service and/or products.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-revenue-center"
}
},
{
"id" : "Claim.item.detail.category",
"path" : "Claim.item.detail.category",
"short" : "Benefit classification",
"definition" : "Code to identify the general type of benefits under which products and services are provided.",
"comment" : "Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.",
"requirements" : "Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.category",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BenefitCategory"
}],
"strength" : "example",
"description" : "Benefit categories such as: oral-basic, major, glasses.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-benefitcategory"
}
},
{
"id" : "Claim.item.detail.productOrService",
"path" : "Claim.item.detail.productOrService",
"short" : "Billing, service, product, or drug code",
"definition" : "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.",
"comment" : "If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.",
"requirements" : "Necessary to state what was provided or done.",
"alias" : ["Drug Code",
"Bill Code",
"Service Code"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.productOrService",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceProduct"
}],
"strength" : "example",
"description" : "Allowable service and product codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-uscls"
}
},
{
"id" : "Claim.item.detail.modifier",
"path" : "Claim.item.detail.modifier",
"short" : "Service/Product billing modifiers",
"definition" : "Item typification or modifiers codes to convey additional context for the product or service.",
"comment" : "For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours.",
"requirements" : "To support inclusion of the item for adjudication or to charge an elevated fee.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.detail.modifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Modifiers"
}],
"strength" : "example",
"description" : "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-modifiers"
}
},
{
"id" : "Claim.item.detail.programCode",
"path" : "Claim.item.detail.programCode",
"short" : "Program the product or service is provided under",
"definition" : "Identifies the program under which this may be recovered.",
"comment" : "For example: Neonatal program, child dental program or drug users recovery program.",
"requirements" : "Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.detail.programCode",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProgramCode"
}],
"strength" : "example",
"description" : "Program specific reason codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-program-code"
}
},
{
"id" : "Claim.item.detail.quantity",
"path" : "Claim.item.detail.quantity",
"short" : "Count of products or services",
"definition" : "The number of repetitions of a service or product.",
"requirements" : "Required when the product or service code does not convey the quantity provided.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.unitPrice",
"path" : "Claim.item.detail.unitPrice",
"short" : "Fee, charge or cost per item",
"definition" : "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.",
"requirements" : "The amount charged to the patient by the provider for a single unit.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.unitPrice",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Money"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.factor",
"path" : "Claim.item.detail.factor",
"short" : "Price scaling factor",
"definition" : "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"comment" : "To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).",
"requirements" : "When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.factor",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.net",
"path" : "Claim.item.detail.net",
"short" : "Total item cost",
"definition" : "The quantity times the unit price for an additional service or product or charge.",
"comment" : "For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.",
"requirements" : "Provides the total amount claimed for the group (if a grouper) or the line item.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.net",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Money"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.udi",
"path" : "Claim.item.detail.udi",
"short" : "Unique device identifier",
"definition" : "Unique Device Identifiers associated with this line item.",
"requirements" : "The UDI code allows the insurer to obtain device level information on the product supplied.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.detail.udi",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.subDetail",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "SubDetail"
}],
"path" : "Claim.item.detail.subDetail",
"short" : "Product or service provided",
"definition" : "A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.",
"requirements" : "The items to be processed for adjudication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.detail.subDetail",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.subDetail.id",
"path" : "Claim.item.detail.subDetail.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.item.detail.subDetail.extension",
"path" : "Claim.item.detail.subDetail.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.item.detail.subDetail.modifierExtension",
"path" : "Claim.item.detail.subDetail.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.item.detail.subDetail.sequence",
"path" : "Claim.item.detail.subDetail.sequence",
"short" : "Item instance identifier",
"definition" : "A number to uniquely identify item entries.",
"requirements" : "Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.subDetail.sequence",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.subDetail.revenue",
"path" : "Claim.item.detail.subDetail.revenue",
"short" : "Revenue or cost center code",
"definition" : "The type of revenue or cost center providing the product and/or service.",
"requirements" : "Needed in the processing of institutional claims.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.subDetail.revenue",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RevenueCenter"
}],
"strength" : "example",
"description" : "Codes for the revenue or cost centers supplying the service and/or products.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-revenue-center"
}
},
{
"id" : "Claim.item.detail.subDetail.category",
"path" : "Claim.item.detail.subDetail.category",
"short" : "Benefit classification",
"definition" : "Code to identify the general type of benefits under which products and services are provided.",
"comment" : "Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.",
"requirements" : "Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.subDetail.category",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BenefitCategory"
}],
"strength" : "example",
"description" : "Benefit categories such as: oral-basic, major, glasses.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-benefitcategory"
}
},
{
"id" : "Claim.item.detail.subDetail.productOrService",
"path" : "Claim.item.detail.subDetail.productOrService",
"short" : "Billing, service, product, or drug code",
"definition" : "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.",
"comment" : "If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.",
"requirements" : "Necessary to state what was provided or done.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.subDetail.productOrService",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceProduct"
}],
"strength" : "example",
"description" : "Allowable service and product codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-uscls"
}
},
{
"id" : "Claim.item.detail.subDetail.modifier",
"path" : "Claim.item.detail.subDetail.modifier",
"short" : "Service/Product billing modifiers",
"definition" : "Item typification or modifiers codes to convey additional context for the product or service.",
"comment" : "For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours.",
"requirements" : "To support inclusion of the item for adjudication or to charge an elevated fee.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.detail.subDetail.modifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Modifiers"
}],
"strength" : "example",
"description" : "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-modifiers"
}
},
{
"id" : "Claim.item.detail.subDetail.programCode",
"path" : "Claim.item.detail.subDetail.programCode",
"short" : "Program the product or service is provided under",
"definition" : "Identifies the program under which this may be recovered.",
"comment" : "For example: Neonatal program, child dental program or drug users recovery program.",
"requirements" : "Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.detail.subDetail.programCode",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProgramCode"
}],
"strength" : "example",
"description" : "Program specific reason codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-program-code"
}
},
{
"id" : "Claim.item.detail.subDetail.quantity",
"path" : "Claim.item.detail.subDetail.quantity",
"short" : "Count of products or services",
"definition" : "The number of repetitions of a service or product.",
"requirements" : "Required when the product or service code does not convey the quantity provided.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.subDetail.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.subDetail.unitPrice",
"path" : "Claim.item.detail.subDetail.unitPrice",
"short" : "Fee, charge or cost per item",
"definition" : "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.",
"requirements" : "The amount charged to the patient by the provider for a single unit.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.subDetail.unitPrice",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Money"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.subDetail.factor",
"path" : "Claim.item.detail.subDetail.factor",
"short" : "Price scaling factor",
"definition" : "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"comment" : "To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).",
"requirements" : "When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.subDetail.factor",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.subDetail.net",
"path" : "Claim.item.detail.subDetail.net",
"short" : "Total item cost",
"definition" : "The quantity times the unit price for an additional service or product or charge.",
"comment" : "For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.",
"requirements" : "Provides the total amount claimed for the group (if a grouper) or the line item.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.subDetail.net",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Money"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.subDetail.udi",
"path" : "Claim.item.detail.subDetail.udi",
"short" : "Unique device identifier",
"definition" : "Unique Device Identifiers associated with this line item.",
"requirements" : "The UDI code allows the insurer to obtain device level information on the product supplied.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.detail.subDetail.udi",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.total",
"path" : "Claim.total",
"short" : "Total claim cost",
"definition" : "The total value of the all the items in the claim.",
"requirements" : "Used for control total purposes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.total",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Money"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "Claim",
"path" : "Claim",
"short" : "Claim, Pre-determination or Pre-authorization",
"definition" : "A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.",
"comment" : "The Claim resource fulfills three information request requirements: Claim - a request for adjudication for reimbursement for products and/or services provided; Preauthorization - a request to authorize the future provision of products and/or services including an anticipated adjudication; and, Predetermination - a request for a non-bind adjudication of possible future products and/or services.",
"alias" : ["Adjudication Request",
"Preauthorization Request",
"Predetermination Request"],
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Request"
}]
},
{
"id" : "Claim.identifier",
"path" : "Claim.identifier",
"short" : "Business Identifier for claim",
"definition" : "A unique identifier assigned to this claim.",
"requirements" : "Allows claims to be distinguished and referenced.",
"alias" : ["Claim Number"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "Claim.status",
"path" : "Claim.status",
"short" : "active | cancelled | draft | entered-in-error",
"definition" : "The status of the resource instance.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"requirements" : "Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClaimStatus"
}],
"strength" : "required",
"description" : "A code specifying the state of the resource instance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/fm-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "Claim.type",
"path" : "Claim.type",
"short" : "Category or discipline",
"definition" : "The category of claim, e.g. oral, pharmacy, vision, institutional, professional.",
"comment" : "The majority of jurisdictions use: oral, pharmacy, vision, professional and institutional, or variants on those terms, as the general styles of claims. The valueset is extensible to accommodate other jurisdictional requirements.",
"requirements" : "Claim type determine the general sets of business rules applied for information requirements and adjudication.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClaimType"
}],
"strength" : "extensible",
"description" : "The type or discipline-style of the claim.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Claim.subType",
"path" : "Claim.subType",
"short" : "More granular claim type",
"definition" : "A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.",
"comment" : "This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type.",
"requirements" : "Some jurisdictions need a finer grained claim type for routing and adjudication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClaimSubType"
}],
"strength" : "example",
"description" : "A more granular claim typecode.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-subtype"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Claim.use",
"path" : "Claim.use",
"short" : "claim | preauthorization | predetermination",
"definition" : "A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.",
"requirements" : "This element is required to understand the nature of the request for adjudication.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Use"
}],
"strength" : "required",
"description" : "The purpose of the Claim: predetermination, preauthorization, claim.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-use|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Claim.patient",
"path" : "Claim.patient",
"short" : "The recipient of the products and services",
"definition" : "The party to whom the professional services and/or products have been supplied or are being considered and for whom actual or forecast reimbursement is sought.",
"requirements" : "The patient must be supplied to the insurer so that confirmation of coverage and service history may be considered as part of the authorization and/or adjudiction.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Claim.billablePeriod",
"path" : "Claim.billablePeriod",
"short" : "Relevant time frame for the claim",
"definition" : "The period for which charges are being submitted.",
"comment" : "Typically this would be today or in the past for a claim, and today or in the future for preauthorizations and predeterminations. Typically line item dates of service should fall within the billing period if one is specified.",
"requirements" : "A number jurisdictions required the submission of the billing period when submitting claims for example for hospital stays or long-term care.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
}]
},
{
"id" : "Claim.created",
"path" : "Claim.created",
"short" : "Resource creation date",
"definition" : "The date this resource was created.",
"comment" : "This field is independent of the date of creation of the resource as it may reflect the creation date of a source document prior to digitization. Typically for claims all services must be completed as of this date.",
"requirements" : "Need to record a timestamp for use by both the recipient and the issuer.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.authoredOn"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "Claim.enterer",
"path" : "Claim.enterer",
"short" : "Author of the claim",
"definition" : "Individual who created the claim, predetermination or preauthorization.",
"requirements" : "Some jurisdictions require the contact information for personnel completing claims.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.author"
}]
},
{
"id" : "Claim.insurer",
"path" : "Claim.insurer",
"short" : "Target",
"definition" : "The Insurer who is target of the request.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performer"
}]
},
{
"id" : "Claim.provider",
"path" : "Claim.provider",
"short" : "Party responsible for the claim",
"definition" : "The provider which is responsible for the claim, predetermination or preauthorization.",
"comment" : "Typically this field would be 1..1 where this party is responsible for the claim but not necessarily professionally responsible for the provision of the individual products and services listed below.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.requester"
},
{
"identity" : "w5",
"map" : "FiveWs.source"
}]
},
{
"id" : "Claim.priority",
"path" : "Claim.priority",
"short" : "Desired processing ugency",
"definition" : "The provider-required urgency of processing the request. Typical values include: stat, routine deferred.",
"comment" : "If a claim processor is unable to complete the processing as per the priority then they should generate and error and not process the request.",
"requirements" : "The provider may need to indicate their processing requirements so that the processor can indicate if they are unable to comply.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcessPriority"
}],
"strength" : "example",
"description" : "The timeliness with which processing is required: stat, normal, deferred.",
"valueSet" : "http://hl7.org/fhir/ValueSet/process-priority"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.priority"
}]
},
{
"id" : "Claim.fundsReserve",
"path" : "Claim.fundsReserve",
"short" : "For whom to reserve funds",
"definition" : "A code to indicate whether and for whom funds are to be reserved for future claims.",
"comment" : "This field is only used for preauthorizations.",
"requirements" : "In the case of a Pre-Determination/Pre-Authorization the provider may request that funds in the amount of the expected Benefit be reserved ('Patient' or 'Provider') to pay for the Benefits determined on the subsequent claim(s). 'None' explicitly indicates no funds reserving is requested.",
"alias" : ["Fund pre-allocation"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FundsReserve"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "example",
"description" : "For whom funds are to be reserved: (Patient, Provider, None).",
"valueSet" : "http://hl7.org/fhir/ValueSet/fundsreserve"
}
},
{
"id" : "Claim.related",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "RelatedClaim"
}],
"path" : "Claim.related",
"short" : "Prior or corollary claims",
"definition" : "Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.",
"comment" : "For example, for the original treatment and follow-up exams.",
"requirements" : "For workplace or other accidents it is common to relate separate claims arising from the same event.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "Claim.related.claim",
"path" : "Claim.related.claim",
"short" : "Reference to the related claim",
"definition" : "Reference to a related claim.",
"requirements" : "For workplace or other accidents it is common to relate separate claims arising from the same event.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Claim"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.replaces"
}]
},
{
"id" : "Claim.related.relationship",
"path" : "Claim.related.relationship",
"short" : "How the reference claim is related",
"definition" : "A code to convey how the claims are related.",
"comment" : "For example, prior claim or umbrella.",
"requirements" : "Some insurers need a declaration of the type of relationship.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RelatedClaimRelationship"
}],
"strength" : "example",
"description" : "Relationship of this claim to a related Claim.",
"valueSet" : "http://hl7.org/fhir/ValueSet/related-claim-relationship"
}
},
{
"id" : "Claim.related.reference",
"path" : "Claim.related.reference",
"short" : "File or case reference",
"definition" : "An alternate organizational reference to the case or file to which this particular claim pertains.",
"comment" : "For example, Property/Casualty insurer claim # or Workers Compensation case # .",
"requirements" : "In cases where an event-triggered claim is being submitted to an insurer which requires a reference number to be specified on all exchanges.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}]
},
{
"id" : "Claim.prescription",
"path" : "Claim.prescription",
"short" : "Prescription authorizing services and products",
"definition" : "Prescription to support the dispensing of pharmacy, device or vision products.",
"requirements" : "Required to authorize the dispensing of controlled substances and devices.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DeviceRequest",
"http://hl7.org/fhir/StructureDefinition/MedicationRequest",
"http://hl7.org/fhir/StructureDefinition/VisionPrescription"]
}]
},
{
"id" : "Claim.originalPrescription",
"path" : "Claim.originalPrescription",
"short" : "Original prescription if superseded by fulfiller",
"definition" : "Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.",
"comment" : "For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefore issues a new prescription for an alternate medication which has the same therapeutic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'.",
"requirements" : "Often required when a fulfiller varies what is fulfilled from that authorized on the original prescription.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DeviceRequest",
"http://hl7.org/fhir/StructureDefinition/MedicationRequest",
"http://hl7.org/fhir/StructureDefinition/VisionPrescription"]
}]
},
{
"id" : "Claim.payee",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Payee"
}],
"path" : "Claim.payee",
"short" : "Recipient of benefits payable",
"definition" : "The party to be reimbursed for cost of the products and services according to the terms of the policy.",
"comment" : "Often providers agree to receive the benefits payable to reduce the near-term costs to the patient. The insurer may decline to pay the provider and choose to pay the subscriber instead.",
"requirements" : "The provider needs to specify who they wish to be reimbursed and the claims processor needs express who they will reimburse.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "Claim.payee.type",
"path" : "Claim.payee.type",
"short" : "Category of recipient",
"definition" : "Type of Party to be reimbursed: subscriber, provider, other.",
"requirements" : "Need to know who should receive payment with the most common situations being the Provider (assignment of benefits) or the Subscriber.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PayeeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "example",
"description" : "A code for the party to be reimbursed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/payeetype"
}
},
{
"id" : "Claim.payee.party",
"path" : "Claim.payee.party",
"short" : "Recipient reference",
"definition" : "Reference to the individual or organization to whom any payment will be made.",
"comment" : "Not required if the payee is 'subscriber' or 'provider'.",
"requirements" : "Need to provide demographics if the payee is not 'subscriber' nor 'provider'.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}]
},
{
"id" : "Claim.referral",
"path" : "Claim.referral",
"short" : "Treatment referral",
"definition" : "A reference to a referral resource.",
"comment" : "The referral resource which lists the date, practitioner, reason and other supporting information.",
"requirements" : "Some insurers require proof of referral to pay for services or to pay specialist rates for services.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ServiceRequest"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.cause"
}]
},
{
"id" : "Claim.facility",
"path" : "Claim.facility",
"short" : "Servicing facility",
"definition" : "Facility where the services were provided.",
"requirements" : "Insurance adjudication can be dependant on where services were delivered.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.where[x]"
}]
},
{
"id" : "Claim.careTeam",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "CareTeam"
}],
"path" : "Claim.careTeam",
"short" : "Members of the care team",
"definition" : "The members of the team who provided the products and services.",
"requirements" : "Common to identify the responsible and supporting practitioners.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "Claim.careTeam.sequence",
"path" : "Claim.careTeam.sequence",
"short" : "Order of care team",
"definition" : "A number to uniquely identify care team entries.",
"requirements" : "Necessary to maintain the order of the care team and provide a mechanism to link individuals to claim details.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "Claim.careTeam.provider",
"path" : "Claim.careTeam.provider",
"short" : "Practitioner or organization",
"definition" : "Member of the team who provided the product or service.",
"requirements" : "Often a regulatory requirement to specify the responsible provider.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.actor"
}]
},
{
"id" : "Claim.careTeam.responsible",
"path" : "Claim.careTeam.responsible",
"short" : "Indicator of the lead practitioner",
"definition" : "The party who is billing and/or responsible for the claimed products or services.",
"comment" : "Responsible might not be required when there is only a single provider listed.",
"requirements" : "When multiple parties are present it is required to distinguish the lead or responsible individual.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "Claim.careTeam.role",
"path" : "Claim.careTeam.role",
"short" : "Function within the team",
"definition" : "The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team.",
"comment" : "Role might not be required when there is only a single provider listed.",
"requirements" : "When multiple parties are present it is required to distinguish the roles performed by each member.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CareTeamRole"
}],
"strength" : "example",
"description" : "The role codes for the care team members.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-careteamrole"
}
},
{
"id" : "Claim.careTeam.qualification",
"path" : "Claim.careTeam.qualification",
"short" : "Practitioner credential or specialization",
"definition" : "The qualification of the practitioner which is applicable for this service.",
"requirements" : "Need to specify which qualification a provider is delivering the product or service under.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProviderQualification"
}],
"strength" : "example",
"description" : "Provider professional qualifications.",
"valueSet" : "http://hl7.org/fhir/ValueSet/provider-qualification"
}
},
{
"id" : "Claim.supportingInfo",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "SupportingInformation"
}],
"path" : "Claim.supportingInfo",
"short" : "Supporting information",
"definition" : "Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.",
"comment" : "Often there are multiple jurisdiction specific valuesets which are required.",
"requirements" : "Typically these information codes are required to support the services rendered or the adjudication of the services rendered.",
"alias" : ["Attachments\nException Codes\nOccurrence Codes\nValue codes"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.supportingInfo"
}]
},
{
"id" : "Claim.supportingInfo.sequence",
"path" : "Claim.supportingInfo.sequence",
"short" : "Information instance identifier",
"definition" : "A number to uniquely identify supporting information entries.",
"requirements" : "Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "Claim.supportingInfo.category",
"path" : "Claim.supportingInfo.category",
"short" : "Classification of the supplied information",
"definition" : "The general class of the information supplied: information; exception; accident, employment; onset, etc.",
"comment" : "This may contain a category for the local bill type codes.",
"requirements" : "Required to group or associate information items with common characteristics. For example: admission information or prior treatments.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "InformationCategory"
}],
"strength" : "example",
"description" : "The valuset used for additional information category codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-informationcategory"
}
},
{
"id" : "Claim.supportingInfo.code",
"path" : "Claim.supportingInfo.code",
"short" : "Type of information",
"definition" : "System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.",
"requirements" : "Required to identify the kind of additional information.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "InformationCode"
}],
"strength" : "example",
"description" : "The valuset used for additional information codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-exception"
}
},
{
"id" : "Claim.supportingInfo.timing[x]",
"path" : "Claim.supportingInfo.timing[x]",
"short" : "When it occurred",
"definition" : "The date when or period to which this information refers.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
},
{
"code" : "Period"
}]
},
{
"id" : "Claim.supportingInfo.value[x]",
"path" : "Claim.supportingInfo.value[x]",
"short" : "Data to be provided",
"definition" : "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.",
"comment" : "Could be used to provide references to other resources, document. For example could contain a PDF in an Attachment of the Police Report for an Accident.",
"requirements" : "To convey the data content to be provided when the information is more than a simple code or period.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
},
{
"code" : "string"
},
{
"code" : "Quantity"
},
{
"code" : "Attachment"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}]
},
{
"id" : "Claim.supportingInfo.reason",
"path" : "Claim.supportingInfo.reason",
"short" : "Explanation for the information",
"definition" : "Provides the reason in the situation where a reason code is required in addition to the content.",
"comment" : "For example: the reason for the additional stay, or why a tooth is missing.",
"requirements" : "Needed when the supporting information has both a date and amount/value and requires explanation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MissingReason"
}],
"strength" : "example",
"description" : "Reason codes for the missing teeth.",
"valueSet" : "http://hl7.org/fhir/ValueSet/missing-tooth-reason"
}
},
{
"id" : "Claim.diagnosis",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Diagnosis"
}],
"path" : "Claim.diagnosis",
"short" : "Pertinent diagnosis information",
"definition" : "Information about diagnoses relevant to the claim items.",
"requirements" : "Required for the adjudication by provided context for the services and product listed.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonReference"
}]
},
{
"id" : "Claim.diagnosis.sequence",
"path" : "Claim.diagnosis.sequence",
"short" : "Diagnosis instance identifier",
"definition" : "A number to uniquely identify diagnosis entries.",
"comment" : "Diagnosis are presented in list order to their expected importance: primary, secondary, etc.",
"requirements" : "Necessary to maintain the order of the diagnosis items and provide a mechanism to link to claim details.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "Claim.diagnosis.diagnosis[x]",
"path" : "Claim.diagnosis.diagnosis[x]",
"short" : "Nature of illness or problem",
"definition" : "The nature of illness or problem in a coded form or as a reference to an external defined Condition.",
"requirements" : "Provides health context for the evaluation of the products and/or services.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition"]
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ICD10"
}],
"strength" : "example",
"description" : "Example ICD10 Diagnostic codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/icd-10"
}
},
{
"id" : "Claim.diagnosis.type",
"path" : "Claim.diagnosis.type",
"short" : "Timing or nature of the diagnosis",
"definition" : "When the condition was observed or the relative ranking.",
"comment" : "For example: admitting, primary, secondary, discharge.",
"requirements" : "Often required to capture a particular diagnosis, for example: primary or discharge.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DiagnosisType"
}],
"strength" : "example",
"description" : "The type of the diagnosis: admitting, principal, discharge.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-diagnosistype"
}
},
{
"id" : "Claim.diagnosis.onAdmission",
"path" : "Claim.diagnosis.onAdmission",
"short" : "Present on admission",
"definition" : "Indication of whether the diagnosis was present on admission to a facility.",
"requirements" : "Many systems need to understand for adjudication if the diagnosis was present a time of admission.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DiagnosisOnAdmission"
}],
"strength" : "example",
"description" : "Present on admission.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-diagnosis-on-admission"
}
},
{
"id" : "Claim.diagnosis.packageCode",
"path" : "Claim.diagnosis.packageCode",
"short" : "Package billing code",
"definition" : "A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.",
"comment" : "For example DRG (Diagnosis Related Group) or a bundled billing code. A patient may have a diagnosis of a Myocardial Infarction and a DRG for HeartAttack would be assigned. The Claim item (and possible subsequent claims) would refer to the DRG for those line items that were for services related to the heart attack event.",
"requirements" : "Required to relate the current diagnosis to a package billing code that is then referenced on the individual claim items which are specific to the health condition covered by the package code.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DiagnosisRelatedGroup"
}],
"strength" : "example",
"description" : "The DRG codes associated with the diagnosis.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-diagnosisrelatedgroup"
}
},
{
"id" : "Claim.procedure",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Procedure"
}],
"path" : "Claim.procedure",
"short" : "Clinical procedures performed",
"definition" : "Procedures performed on the patient relevant to the billing items with the claim.",
"requirements" : "The specific clinical invention are sometimes required to be provided to justify billing a greater than customary amount for a service.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "Claim.procedure.sequence",
"path" : "Claim.procedure.sequence",
"short" : "Procedure instance identifier",
"definition" : "A number to uniquely identify procedure entries.",
"requirements" : "Necessary to provide a mechanism to link to claim details.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "Claim.procedure.type",
"path" : "Claim.procedure.type",
"short" : "Category of Procedure",
"definition" : "When the condition was observed or the relative ranking.",
"comment" : "For example: primary, secondary.",
"requirements" : "Often required to capture a particular diagnosis, for example: primary or discharge.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedureType"
}],
"strength" : "example",
"description" : "Example procedure type codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-procedure-type"
}
},
{
"id" : "Claim.procedure.date",
"path" : "Claim.procedure.date",
"short" : "When the procedure was performed",
"definition" : "Date and optionally time the procedure was performed.",
"requirements" : "Required for auditing purposes.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}]
},
{
"id" : "Claim.procedure.procedure[x]",
"path" : "Claim.procedure.procedure[x]",
"short" : "Specific clinical procedure",
"definition" : "The code or reference to a Procedure resource which identifies the clinical intervention performed.",
"requirements" : "This identifies the actual clinical procedure.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Procedure"]
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ICD10_Procedures"
}],
"strength" : "example",
"description" : "Example ICD10 Procedure codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/icd-10-procedures"
}
},
{
"id" : "Claim.procedure.udi",
"path" : "Claim.procedure.udi",
"short" : "Unique device identifier",
"definition" : "Unique Device Identifiers associated with this line item.",
"requirements" : "The UDI code allows the insurer to obtain device level information on the product supplied.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}]
},
{
"id" : "Claim.insurance",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Insurance"
}],
"path" : "Claim.insurance",
"short" : "Patient insurance information",
"definition" : "Financial instruments for reimbursement for the health care products and services specified on the claim.",
"comment" : "All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'Coverage.subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.",
"requirements" : "At least one insurer is required for a claim to be a claim.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "Coverage"
}]
},
{
"id" : "Claim.insurance.sequence",
"path" : "Claim.insurance.sequence",
"short" : "Insurance instance identifier",
"definition" : "A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.",
"requirements" : "To maintain order of the coverages.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}],
"isSummary" : true
},
{
"id" : "Claim.insurance.focal",
"path" : "Claim.insurance.focal",
"short" : "Coverage to be used for adjudication",
"definition" : "A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.",
"comment" : "A patient may (will) have multiple insurance policies which provide reimbursement for healthcare services and products. For example a person may also be covered by their spouse's policy and both appear in the list (and may be from the same insurer). This flag will be set to true for only one of the listed policies and that policy will be used for adjudicating this claim. Other claims would be created to request adjudication against the other listed policies.",
"requirements" : "To identify which coverage in the list is being used to adjudicate this claim.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true
},
{
"id" : "Claim.insurance.identifier",
"path" : "Claim.insurance.identifier",
"short" : "Pre-assigned Claim number",
"definition" : "The business identifier to be used when the claim is sent for adjudication against this insurance policy.",
"comment" : "Only required in jurisdictions where insurers, rather than the provider, are required to send claims to insurers that appear after them in the list. This element is not required when 'subrogation=true'.",
"requirements" : "This will be the claim number should it be necessary to create this claim in the future. This is provided so that payors may forward claims to other payors in the Coordination of Benefit for adjudication rather than the provider being required to initiate each adjudication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "Claim.insurance.coverage",
"path" : "Claim.insurance.coverage",
"short" : "Insurance information",
"definition" : "Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.",
"requirements" : "Required to allow the adjudicator to locate the correct policy and history within their information system.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Coverage"]
}],
"isSummary" : true
},
{
"id" : "Claim.insurance.businessArrangement",
"path" : "Claim.insurance.businessArrangement",
"short" : "Additional provider contract number",
"definition" : "A business agreement number established between the provider and the insurer for special business processing purposes.",
"requirements" : "Providers may have multiple business arrangements with a given insurer and must supply the specific contract number for adjudication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "Claim.insurance.preAuthRef",
"path" : "Claim.insurance.preAuthRef",
"short" : "Prior authorization reference number",
"definition" : "Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization.",
"comment" : "This value is an alphanumeric string that may be provided over the phone, via text, via paper, or within a ClaimResponse resource and is not a FHIR Identifier.",
"requirements" : "Providers must quote previously issued authorization reference numbers in order to obtain adjudication as previously advised on the Preauthorization.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "string"
}]
},
{
"id" : "Claim.insurance.claimResponse",
"path" : "Claim.insurance.claimResponse",
"short" : "Adjudication results",
"definition" : "The result of the adjudication of the line items for the Coverage specified in this insurance.",
"comment" : "Must not be specified when 'focal=true' for this insurance.",
"requirements" : "An insurer need the adjudication results from prior insurers to determine the outstanding balance remaining by item for the items in the curent claim.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ClaimResponse"]
}]
},
{
"id" : "Claim.accident",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Accident"
}],
"path" : "Claim.accident",
"short" : "Details of the event",
"definition" : "Details of an accident which resulted in injuries which required the products and services listed in the claim.",
"requirements" : "When healthcare products and services are accident related, benefits may be payable under accident provisions of policies, such as automotive, etc before they are payable under normal health insurance.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "Claim.accident.date",
"path" : "Claim.accident.date",
"short" : "When the incident occurred",
"definition" : "Date of an accident event related to the products and services contained in the claim.",
"comment" : "The date of the accident has to precede the dates of the products and services but within a reasonable timeframe.",
"requirements" : "Required for audit purposes and adjudication.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "date"
}]
},
{
"id" : "Claim.accident.type",
"path" : "Claim.accident.type",
"short" : "The nature of the accident",
"definition" : "The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers.",
"requirements" : "Coverage may be dependant on the type of accident.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AccidentType"
}],
"strength" : "extensible",
"description" : "Type of accident: work place, auto, etc.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActIncidentCode"
}
},
{
"id" : "Claim.accident.location[x]",
"path" : "Claim.accident.location[x]",
"short" : "Where the event occurred",
"definition" : "The physical location of the accident event.",
"requirements" : "Required for audit purposes and determination of applicable insurance liability.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Address"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}]
},
{
"id" : "Claim.item",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Item"
}],
"path" : "Claim.item",
"short" : "Product or service provided",
"definition" : "A claim line. Either a simple product or service or a 'group' of details which can each be a simple items or groups of sub-details.",
"requirements" : "The items to be processed for adjudication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "Claim.item.sequence",
"path" : "Claim.item.sequence",
"short" : "Item instance identifier",
"definition" : "A number to uniquely identify item entries.",
"requirements" : "Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "Claim.item.careTeamSequence",
"path" : "Claim.item.careTeamSequence",
"short" : "Applicable careTeam members",
"definition" : "CareTeam members related to this service or product.",
"requirements" : "Need to identify the individuals and their roles in the provision of the product or service.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "Claim.item.diagnosisSequence",
"path" : "Claim.item.diagnosisSequence",
"short" : "Applicable diagnoses",
"definition" : "Diagnosis applicable for this service or product.",
"requirements" : "Need to related the product or service to the associated diagnoses.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "Claim.item.procedureSequence",
"path" : "Claim.item.procedureSequence",
"short" : "Applicable procedures",
"definition" : "Procedures applicable for this service or product.",
"requirements" : "Need to provide any listed specific procedures to support the product or service being claimed.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "Claim.item.informationSequence",
"path" : "Claim.item.informationSequence",
"short" : "Applicable exception and supporting information",
"definition" : "Exceptions, special conditions and supporting information applicable for this service or product.",
"requirements" : "Need to reference the supporting information items that relate directly to this product or service.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "Claim.item.revenue",
"path" : "Claim.item.revenue",
"short" : "Revenue or cost center code",
"definition" : "The type of revenue or cost center providing the product and/or service.",
"requirements" : "Needed in the processing of institutional claims.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RevenueCenter"
}],
"strength" : "example",
"description" : "Codes for the revenue or cost centers supplying the service and/or products.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-revenue-center"
}
},
{
"id" : "Claim.item.category",
"path" : "Claim.item.category",
"short" : "Benefit classification",
"definition" : "Code to identify the general type of benefits under which products and services are provided.",
"comment" : "Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.",
"requirements" : "Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BenefitCategory"
}],
"strength" : "example",
"description" : "Benefit categories such as: oral-basic, major, glasses.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-benefitcategory"
}
},
{
"id" : "Claim.item.productOrService",
"path" : "Claim.item.productOrService",
"short" : "Billing, service, product, or drug code",
"definition" : "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.",
"comment" : "If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.",
"requirements" : "Necessary to state what was provided or done.",
"alias" : ["Drug Code",
"Bill Code",
"Service Code"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceProduct"
}],
"strength" : "example",
"description" : "Allowable service and product codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-uscls"
}
},
{
"id" : "Claim.item.modifier",
"path" : "Claim.item.modifier",
"short" : "Product or service billing modifiers",
"definition" : "Item typification or modifiers codes to convey additional context for the product or service.",
"comment" : "For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours.",
"requirements" : "To support inclusion of the item for adjudication or to charge an elevated fee.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Modifiers"
}],
"strength" : "example",
"description" : "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-modifiers"
}
},
{
"id" : "Claim.item.programCode",
"path" : "Claim.item.programCode",
"short" : "Program the product or service is provided under",
"definition" : "Identifies the program under which this may be recovered.",
"comment" : "For example: Neonatal program, child dental program or drug users recovery program.",
"requirements" : "Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProgramCode"
}],
"strength" : "example",
"description" : "Program specific reason codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-program-code"
}
},
{
"id" : "Claim.item.serviced[x]",
"path" : "Claim.item.serviced[x]",
"short" : "Date or dates of service or product delivery",
"definition" : "The date or dates when the service or product was supplied, performed or completed.",
"requirements" : "Needed to determine whether the service or product was provided during the term of the insurance coverage.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
},
{
"code" : "Period"
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
}]
},
{
"id" : "Claim.item.location[x]",
"path" : "Claim.item.location[x]",
"short" : "Place of service or where product was supplied",
"definition" : "Where the product or service was provided.",
"requirements" : "The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Address"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServicePlace"
}],
"strength" : "example",
"description" : "Place of service: pharmacy, school, prison, etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-place"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.where[x]"
}]
},
{
"id" : "Claim.item.quantity",
"path" : "Claim.item.quantity",
"short" : "Count of products or services",
"definition" : "The number of repetitions of a service or product.",
"requirements" : "Required when the product or service code does not convey the quantity provided.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}]
},
{
"id" : "Claim.item.unitPrice",
"path" : "Claim.item.unitPrice",
"short" : "Fee, charge or cost per item",
"definition" : "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.",
"requirements" : "The amount charged to the patient by the provider for a single unit.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}]
},
{
"id" : "Claim.item.factor",
"path" : "Claim.item.factor",
"short" : "Price scaling factor",
"definition" : "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"comment" : "To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).",
"requirements" : "When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}]
},
{
"id" : "Claim.item.net",
"path" : "Claim.item.net",
"short" : "Total item cost",
"definition" : "The quantity times the unit price for an additional service or product or charge.",
"comment" : "For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.",
"requirements" : "Provides the total amount claimed for the group (if a grouper) or the line item.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}]
},
{
"id" : "Claim.item.udi",
"path" : "Claim.item.udi",
"short" : "Unique device identifier",
"definition" : "Unique Device Identifiers associated with this line item.",
"requirements" : "The UDI code allows the insurer to obtain device level information on the product supplied.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}]
},
{
"id" : "Claim.item.bodySite",
"path" : "Claim.item.bodySite",
"short" : "Anatomical location",
"definition" : "Physical service site on the patient (limb, tooth, etc.).",
"comment" : "For example: Providing a tooth code, allows an insurer to identify a provider performing a filling on a tooth that was previously removed.",
"requirements" : "Allows insurer to validate specific procedures.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "OralSites"
}],
"strength" : "example",
"description" : "The code for the teeth, quadrant, sextant and arch.",
"valueSet" : "http://hl7.org/fhir/ValueSet/tooth"
}
},
{
"id" : "Claim.item.subSite",
"path" : "Claim.item.subSite",
"short" : "Anatomical sub-location",
"definition" : "A region or surface of the bodySite, e.g. limb region or tooth surface(s).",
"requirements" : "Allows insurer to validate specific procedures.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Surface"
}],
"strength" : "example",
"description" : "The code for the tooth surface and surface combinations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/surface"
}
},
{
"id" : "Claim.item.encounter",
"path" : "Claim.item.encounter",
"short" : "Encounters related to this billed item",
"definition" : "The Encounters during which this Claim was created or to which the creation of this record is tightly associated.",
"comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.",
"requirements" : "Used in some jurisdictions to link clinical events to claim items.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.context"
}]
},
{
"id" : "Claim.item.detail",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Detail"
}],
"path" : "Claim.item.detail",
"short" : "Product or service provided",
"definition" : "A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.",
"requirements" : "The items to be processed for adjudication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "Claim.item.detail.sequence",
"path" : "Claim.item.detail.sequence",
"short" : "Item instance identifier",
"definition" : "A number to uniquely identify item entries.",
"requirements" : "Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "Claim.item.detail.revenue",
"path" : "Claim.item.detail.revenue",
"short" : "Revenue or cost center code",
"definition" : "The type of revenue or cost center providing the product and/or service.",
"requirements" : "Needed in the processing of institutional claims.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RevenueCenter"
}],
"strength" : "example",
"description" : "Codes for the revenue or cost centers supplying the service and/or products.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-revenue-center"
}
},
{
"id" : "Claim.item.detail.category",
"path" : "Claim.item.detail.category",
"short" : "Benefit classification",
"definition" : "Code to identify the general type of benefits under which products and services are provided.",
"comment" : "Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.",
"requirements" : "Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BenefitCategory"
}],
"strength" : "example",
"description" : "Benefit categories such as: oral-basic, major, glasses.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-benefitcategory"
}
},
{
"id" : "Claim.item.detail.productOrService",
"path" : "Claim.item.detail.productOrService",
"short" : "Billing, service, product, or drug code",
"definition" : "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.",
"comment" : "If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.",
"requirements" : "Necessary to state what was provided or done.",
"alias" : ["Drug Code",
"Bill Code",
"Service Code"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceProduct"
}],
"strength" : "example",
"description" : "Allowable service and product codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-uscls"
}
},
{
"id" : "Claim.item.detail.modifier",
"path" : "Claim.item.detail.modifier",
"short" : "Service/Product billing modifiers",
"definition" : "Item typification or modifiers codes to convey additional context for the product or service.",
"comment" : "For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours.",
"requirements" : "To support inclusion of the item for adjudication or to charge an elevated fee.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Modifiers"
}],
"strength" : "example",
"description" : "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-modifiers"
}
},
{
"id" : "Claim.item.detail.programCode",
"path" : "Claim.item.detail.programCode",
"short" : "Program the product or service is provided under",
"definition" : "Identifies the program under which this may be recovered.",
"comment" : "For example: Neonatal program, child dental program or drug users recovery program.",
"requirements" : "Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProgramCode"
}],
"strength" : "example",
"description" : "Program specific reason codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-program-code"
}
},
{
"id" : "Claim.item.detail.quantity",
"path" : "Claim.item.detail.quantity",
"short" : "Count of products or services",
"definition" : "The number of repetitions of a service or product.",
"requirements" : "Required when the product or service code does not convey the quantity provided.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}]
},
{
"id" : "Claim.item.detail.unitPrice",
"path" : "Claim.item.detail.unitPrice",
"short" : "Fee, charge or cost per item",
"definition" : "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.",
"requirements" : "The amount charged to the patient by the provider for a single unit.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}]
},
{
"id" : "Claim.item.detail.factor",
"path" : "Claim.item.detail.factor",
"short" : "Price scaling factor",
"definition" : "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"comment" : "To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).",
"requirements" : "When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}]
},
{
"id" : "Claim.item.detail.net",
"path" : "Claim.item.detail.net",
"short" : "Total item cost",
"definition" : "The quantity times the unit price for an additional service or product or charge.",
"comment" : "For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.",
"requirements" : "Provides the total amount claimed for the group (if a grouper) or the line item.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}]
},
{
"id" : "Claim.item.detail.udi",
"path" : "Claim.item.detail.udi",
"short" : "Unique device identifier",
"definition" : "Unique Device Identifiers associated with this line item.",
"requirements" : "The UDI code allows the insurer to obtain device level information on the product supplied.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}]
},
{
"id" : "Claim.item.detail.subDetail",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "SubDetail"
}],
"path" : "Claim.item.detail.subDetail",
"short" : "Product or service provided",
"definition" : "A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.",
"requirements" : "The items to be processed for adjudication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "Claim.item.detail.subDetail.sequence",
"path" : "Claim.item.detail.subDetail.sequence",
"short" : "Item instance identifier",
"definition" : "A number to uniquely identify item entries.",
"requirements" : "Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "Claim.item.detail.subDetail.revenue",
"path" : "Claim.item.detail.subDetail.revenue",
"short" : "Revenue or cost center code",
"definition" : "The type of revenue or cost center providing the product and/or service.",
"requirements" : "Needed in the processing of institutional claims.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RevenueCenter"
}],
"strength" : "example",
"description" : "Codes for the revenue or cost centers supplying the service and/or products.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-revenue-center"
}
},
{
"id" : "Claim.item.detail.subDetail.category",
"path" : "Claim.item.detail.subDetail.category",
"short" : "Benefit classification",
"definition" : "Code to identify the general type of benefits under which products and services are provided.",
"comment" : "Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.",
"requirements" : "Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BenefitCategory"
}],
"strength" : "example",
"description" : "Benefit categories such as: oral-basic, major, glasses.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-benefitcategory"
}
},
{
"id" : "Claim.item.detail.subDetail.productOrService",
"path" : "Claim.item.detail.subDetail.productOrService",
"short" : "Billing, service, product, or drug code",
"definition" : "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.",
"comment" : "If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.",
"requirements" : "Necessary to state what was provided or done.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceProduct"
}],
"strength" : "example",
"description" : "Allowable service and product codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-uscls"
}
},
{
"id" : "Claim.item.detail.subDetail.modifier",
"path" : "Claim.item.detail.subDetail.modifier",
"short" : "Service/Product billing modifiers",
"definition" : "Item typification or modifiers codes to convey additional context for the product or service.",
"comment" : "For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours.",
"requirements" : "To support inclusion of the item for adjudication or to charge an elevated fee.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Modifiers"
}],
"strength" : "example",
"description" : "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-modifiers"
}
},
{
"id" : "Claim.item.detail.subDetail.programCode",
"path" : "Claim.item.detail.subDetail.programCode",
"short" : "Program the product or service is provided under",
"definition" : "Identifies the program under which this may be recovered.",
"comment" : "For example: Neonatal program, child dental program or drug users recovery program.",
"requirements" : "Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProgramCode"
}],
"strength" : "example",
"description" : "Program specific reason codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-program-code"
}
},
{
"id" : "Claim.item.detail.subDetail.quantity",
"path" : "Claim.item.detail.subDetail.quantity",
"short" : "Count of products or services",
"definition" : "The number of repetitions of a service or product.",
"requirements" : "Required when the product or service code does not convey the quantity provided.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}]
},
{
"id" : "Claim.item.detail.subDetail.unitPrice",
"path" : "Claim.item.detail.subDetail.unitPrice",
"short" : "Fee, charge or cost per item",
"definition" : "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.",
"requirements" : "The amount charged to the patient by the provider for a single unit.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}]
},
{
"id" : "Claim.item.detail.subDetail.factor",
"path" : "Claim.item.detail.subDetail.factor",
"short" : "Price scaling factor",
"definition" : "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"comment" : "To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).",
"requirements" : "When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}]
},
{
"id" : "Claim.item.detail.subDetail.net",
"path" : "Claim.item.detail.subDetail.net",
"short" : "Total item cost",
"definition" : "The quantity times the unit price for an additional service or product or charge.",
"comment" : "For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.",
"requirements" : "Provides the total amount claimed for the group (if a grouper) or the line item.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}]
},
{
"id" : "Claim.item.detail.subDetail.udi",
"path" : "Claim.item.detail.subDetail.udi",
"short" : "Unique device identifier",
"definition" : "Unique Device Identifiers associated with this line item.",
"requirements" : "The UDI code allows the insurer to obtain device level information on the product supplied.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}]
},
{
"id" : "Claim.total",
"path" : "Claim.total",
"short" : "Total claim cost",
"definition" : "The total value of the all the items in the claim.",
"requirements" : "Used for control total purposes.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/ClaimResponse",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "ClaimResponse",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints ClaimResponse TU DomainResource Response to a claim predetermination or preauthorization
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension \r\n identifier 0..* Identifier Business Identifier for a claim response
\r\n status ?!Σ 1..1 code active | cancelled | draft | entered-in-error
Financial Resource Status Codes (Required) \r\n type Σ 1..1 CodeableConcept More granular claim type
Claim Type Codes (Extensible) \r\n subType 0..1 CodeableConcept More granular claim type
Example Claim SubType Codes (Example) \r\n use Σ 1..1 code claim | preauthorization | predetermination
Use (Required) \r\n patient Σ 1..1 Reference(Patient) The recipient of the products and services \r\n created Σ 1..1 dateTime Response creation date \r\n insurer Σ 1..1 Reference(Organization) Party responsible for reimbursement \r\n requestor 0..1 Reference(Practitioner | PractitionerRole | Organization) Party responsible for the claim \r\n request Σ 0..1 Reference(Claim) Id of resource triggering adjudication \r\n outcome Σ 1..1 code queued | complete | error | partial
Claim Processing Codes (Required) \r\n disposition 0..1 string Disposition Message \r\n preAuthRef 0..1 string Preauthorization reference \r\n preAuthPeriod 0..1 Period Preauthorization reference effective period \r\n payeeType 0..1 CodeableConcept Party to be paid any benefits payable
PayeeType (Example) \r\n item 0..* BackboneElement Adjudication for claim line items
\r\n itemSequence 1..1 positiveInt Claim item instance identifier \r\n noteNumber 0..* positiveInt Applicable note numbers
\r\n adjudication 1..* BackboneElement Adjudication details
\r\n category 1..1 CodeableConcept Type of adjudication information
Adjudication Value Codes (Example) \r\n reason 0..1 CodeableConcept Explanation of adjudication outcome
Adjudication Reason Codes (Example) \r\n amount 0..1 Money Monetary amount \r\n value 0..1 decimal Non-monetary value \r\n detail 0..* BackboneElement Adjudication for claim details
\r\n detailSequence 1..1 positiveInt Claim detail instance identifier \r\n noteNumber 0..* positiveInt Applicable note numbers
\r\n adjudication 1..* see adjudication Detail level adjudication details
\r\n subDetail 0..* BackboneElement Adjudication for claim sub-details
\r\n subDetailSequence 1..1 positiveInt Claim sub-detail instance identifier \r\n noteNumber 0..* positiveInt Applicable note numbers
\r\n adjudication 0..* see adjudication Subdetail level adjudication details
\r\n addItem 0..* BackboneElement Insurer added line items
\r\n itemSequence 0..* positiveInt Item sequence number
\r\n detailSequence 0..* positiveInt Detail sequence number
\r\n subdetailSequence 0..* positiveInt Subdetail sequence number
\r\n provider 0..* Reference(Practitioner | PractitionerRole | Organization) Authorized providers
\r\n productOrService 1..1 CodeableConcept Billing, service, product, or drug code
USCLS Codes (Example) \r\n modifier 0..* CodeableConcept Service/Product billing modifiers
Modifier type Codes (Example)
\r\n programCode 0..* CodeableConcept Program the product or service is provided under
Example Program Reason Codes (Example)
\r\n serviced[x] 0..1 Date or dates of service or product delivery \r\n servicedDate date \r\n servicedPeriod Period \r\n location[x] 0..1 Place of service or where product was supplied
Example Service Place Codes (Example) \r\n locationCodeableConcept CodeableConcept \r\n locationAddress Address \r\n locationReference Reference(Location) \r\n quantity 0..1 SimpleQuantity Count of products or services \r\n unitPrice 0..1 Money Fee, charge or cost per item \r\n factor 0..1 decimal Price scaling factor \r\n net 0..1 Money Total item cost \r\n bodySite 0..1 CodeableConcept Anatomical location
Oral Site Codes (Example) \r\n subSite 0..* CodeableConcept Anatomical sub-location
Surface Codes (Example)
\r\n noteNumber 0..* positiveInt Applicable note numbers
\r\n adjudication 1..* see adjudication Added items adjudication
\r\n detail 0..* BackboneElement Insurer added line details
\r\n productOrService 1..1 CodeableConcept Billing, service, product, or drug code
USCLS Codes (Example) \r\n modifier 0..* CodeableConcept Service/Product billing modifiers
Modifier type Codes (Example)
\r\n quantity 0..1 SimpleQuantity Count of products or services \r\n unitPrice 0..1 Money Fee, charge or cost per item \r\n factor 0..1 decimal Price scaling factor \r\n net 0..1 Money Total item cost \r\n noteNumber 0..* positiveInt Applicable note numbers
\r\n adjudication 1..* see adjudication Added items detail adjudication
\r\n subDetail 0..* BackboneElement Insurer added line items
\r\n productOrService 1..1 CodeableConcept Billing, service, product, or drug code
USCLS Codes (Example) \r\n modifier 0..* CodeableConcept Service/Product billing modifiers
Modifier type Codes (Example)
\r\n quantity 0..1 SimpleQuantity Count of products or services \r\n unitPrice 0..1 Money Fee, charge or cost per item \r\n factor 0..1 decimal Price scaling factor \r\n net 0..1 Money Total item cost \r\n noteNumber 0..* positiveInt Applicable note numbers
\r\n adjudication 1..* see adjudication Added items detail adjudication
\r\n adjudication 0..* see adjudication Header-level adjudication
\r\n total Σ 0..* BackboneElement Adjudication totals
\r\n category Σ 1..1 CodeableConcept Type of adjudication information
Adjudication Value Codes (Example) \r\n amount Σ 1..1 Money Financial total for the category \r\n payment 0..1 BackboneElement Payment Details \r\n type 1..1 CodeableConcept Partial or complete payment
Example Payment Type Codes (Example) \r\n adjustment 0..1 Money Payment adjustment for non-claim issues \r\n adjustmentReason 0..1 CodeableConcept Explanation for the adjustment
Payment Adjustment Reason Codes (Example) \r\n date 0..1 date Expected date of payment \r\n amount 1..1 Money Payable amount after adjustment \r\n identifier 0..1 Identifier Business identifier for the payment \r\n fundsReserve 0..1 CodeableConcept Funds reserved status
FundsReserve (Example) \r\n formCode 0..1 CodeableConcept Printed form identifier
Forms (Example) \r\n form 0..1 Attachment Printed reference or actual form \r\n processNote 0..* BackboneElement Note concerning adjudication
\r\n number 0..1 positiveInt Note instance identifier \r\n type 0..1 code display | print | printoper
NoteType (Required) \r\n text 1..1 string Note explanatory text \r\n language 0..1 CodeableConcept Language of the text
Common Languages (Preferred but limited to AllLanguages) \r\n communicationRequest 0..* Reference(CommunicationRequest) Request for additional information
\r\n insurance 0..* BackboneElement Patient insurance information
\r\n sequence 1..1 positiveInt Insurance instance identifier \r\n focal 1..1 boolean Coverage to be used for adjudication \r\n coverage 1..1 Reference(Coverage) Insurance information \r\n businessArrangement 0..1 string Additional provider contract number \r\n claimResponse 0..1 Reference(ClaimResponse) Adjudication results \r\n error 0..* BackboneElement Processing errors
\r\n itemSequence 0..1 positiveInt Item sequence number \r\n detailSequence 0..1 positiveInt Detail sequence number \r\n subDetailSequence 0..1 positiveInt Subdetail sequence number \r\n code 1..1 CodeableConcept Error code detailing processing issues
AdjudicationError (Example) \r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Financial.Billing"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fm"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/ClaimResponse",
"version" : "4.0.0",
"name" : "ClaimResponse",
"status" : "draft",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (Financial Management)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fm/index.cfm"
}]
}],
"description" : "This resource provides the adjudication details from the processing of a Claim resource.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "ClaimResponse",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "ClaimResponse",
"path" : "ClaimResponse",
"short" : "Response to a claim predetermination or preauthorization",
"definition" : "This resource provides the adjudication details from the processing of a Claim resource.",
"alias" : ["Remittance Advice"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Event"
}]
},
{
"id" : "ClaimResponse.id",
"path" : "ClaimResponse.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ClaimResponse.meta",
"path" : "ClaimResponse.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ClaimResponse.implicitRules",
"path" : "ClaimResponse.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "ClaimResponse.language",
"path" : "ClaimResponse.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "ClaimResponse.text",
"path" : "ClaimResponse.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "ClaimResponse.contained",
"path" : "ClaimResponse.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ClaimResponse.extension",
"path" : "ClaimResponse.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ClaimResponse.modifierExtension",
"path" : "ClaimResponse.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ClaimResponse.identifier",
"path" : "ClaimResponse.identifier",
"short" : "Business Identifier for a claim response",
"definition" : "A unique identifier assigned to this claim response.",
"requirements" : "Allows claim responses to be distinguished and referenced.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "ClaimResponse.status",
"path" : "ClaimResponse.status",
"short" : "active | cancelled | draft | entered-in-error",
"definition" : "The status of the resource instance.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"requirements" : "Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClaimResponse.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClaimResponseStatus"
}],
"strength" : "required",
"description" : "A code specifying the state of the resource instance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/fm-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "ClaimResponse.type",
"path" : "ClaimResponse.type",
"short" : "More granular claim type",
"definition" : "A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.",
"comment" : "This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type.",
"requirements" : "Some jurisdictions need a finer grained claim type for routing and adjudication.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClaimResponse.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClaimType"
}],
"strength" : "extensible",
"description" : "The type or discipline-style of the claim.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "ClaimResponse.subType",
"path" : "ClaimResponse.subType",
"short" : "More granular claim type",
"definition" : "A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.",
"comment" : "This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type.",
"requirements" : "Some jurisdictions need a finer grained claim type for routing and adjudication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.subType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClaimSubType"
}],
"strength" : "example",
"description" : "A more granular claim typecode.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-subtype"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "ClaimResponse.use",
"path" : "ClaimResponse.use",
"short" : "claim | preauthorization | predetermination",
"definition" : "A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.",
"requirements" : "This element is required to understand the nature of the request for adjudication.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClaimResponse.use",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Use"
}],
"strength" : "required",
"description" : "Claim, preauthorization, predetermination.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-use|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "ClaimResponse.patient",
"path" : "ClaimResponse.patient",
"short" : "The recipient of the products and services",
"definition" : "The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought.",
"requirements" : "The patient must be supplied to the insurer so that confirmation of coverage and service hstory may be considered as part of the authorization and/or adjudiction.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClaimResponse.patient",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "ClaimResponse.created",
"path" : "ClaimResponse.created",
"short" : "Response creation date",
"definition" : "The date this resource was created.",
"requirements" : "Need to record a timestamp for use by both the recipient and the issuer.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClaimResponse.created",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "ClaimResponse.insurer",
"path" : "ClaimResponse.insurer",
"short" : "Party responsible for reimbursement",
"definition" : "The party responsible for authorization, adjudication and reimbursement.",
"requirements" : "To be a valid claim, preauthorization or predetermination there must be a party who is responsible for adjudicating the contents against a policy which provides benefits for the patient.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClaimResponse.insurer",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
}]
},
{
"id" : "ClaimResponse.requestor",
"path" : "ClaimResponse.requestor",
"short" : "Party responsible for the claim",
"definition" : "The provider which is responsible for the claim, predetermination or preauthorization.",
"comment" : "Typically this field would be 1..1 where this party is responsible for the claim but not necessarily professionally responsible for the provision of the individual products and services listed below.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.requestor",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.source"
}]
},
{
"id" : "ClaimResponse.request",
"path" : "ClaimResponse.request",
"short" : "Id of resource triggering adjudication",
"definition" : "Original request resource reference.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.request",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Claim"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
}]
},
{
"id" : "ClaimResponse.outcome",
"path" : "ClaimResponse.outcome",
"short" : "queued | complete | error | partial",
"definition" : "The outcome of the claim, predetermination, or preauthorization processing.",
"comment" : "The resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete).",
"requirements" : "To advise the requestor of an overall processing outcome.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClaimResponse.outcome",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RemittanceOutcome"
}],
"strength" : "required",
"description" : "The result of the claim processing.",
"valueSet" : "http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.0"
}
},
{
"id" : "ClaimResponse.disposition",
"path" : "ClaimResponse.disposition",
"short" : "Disposition Message",
"definition" : "A human readable description of the status of the adjudication.",
"requirements" : "Provided for user display.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.disposition",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
}]
},
{
"id" : "ClaimResponse.preAuthRef",
"path" : "ClaimResponse.preAuthRef",
"short" : "Preauthorization reference",
"definition" : "Reference from the Insurer which is used in later communications which refers to this adjudication.",
"comment" : "This value is only present on preauthorization adjudications.",
"requirements" : "On subsequent claims, the insurer may require the provider to quote this value.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.preAuthRef",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.preAuthPeriod",
"path" : "ClaimResponse.preAuthPeriod",
"short" : "Preauthorization reference effective period",
"definition" : "The time frame during which this authorization is effective.",
"requirements" : "To convey to the provider when the authorized products and services must be supplied for the authorized adjudication to apply.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.preAuthPeriod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.payeeType",
"path" : "ClaimResponse.payeeType",
"short" : "Party to be paid any benefits payable",
"definition" : "Type of Party to be reimbursed: subscriber, provider, other.",
"requirements" : "Need to know who should receive payment with the most common situations being the Provider (assignment of benefits) or the Subscriber.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.payeeType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PayeeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "example",
"description" : "A code for the party to be reimbursed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/payeetype"
}
},
{
"id" : "ClaimResponse.item",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Item"
}],
"path" : "ClaimResponse.item",
"short" : "Adjudication for claim line items",
"definition" : "A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.",
"requirements" : "The adjudication for items provided on the claim.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.item",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.item.id",
"path" : "ClaimResponse.item.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClaimResponse.item.extension",
"path" : "ClaimResponse.item.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClaimResponse.item.modifierExtension",
"path" : "ClaimResponse.item.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ClaimResponse.item.itemSequence",
"path" : "ClaimResponse.item.itemSequence",
"short" : "Claim item instance identifier",
"definition" : "A number to uniquely reference the claim item entries.",
"requirements" : "Necessary to provide a mechanism to link the adjudication result to the submitted claim item.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClaimResponse.item.itemSequence",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.item.noteNumber",
"path" : "ClaimResponse.item.noteNumber",
"short" : "Applicable note numbers",
"definition" : "The numbers associated with notes below which apply to the adjudication of this item.",
"requirements" : "Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.item.noteNumber",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.item.adjudication",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Adjudication"
}],
"path" : "ClaimResponse.item.adjudication",
"short" : "Adjudication details",
"definition" : "If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.",
"requirements" : "The adjudication results conveys the insurer's assessment of the item provided in the claim under the terms of the patient's insurance coverage.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "ClaimResponse.item.adjudication",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.item.adjudication.id",
"path" : "ClaimResponse.item.adjudication.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClaimResponse.item.adjudication.extension",
"path" : "ClaimResponse.item.adjudication.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClaimResponse.item.adjudication.modifierExtension",
"path" : "ClaimResponse.item.adjudication.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ClaimResponse.item.adjudication.category",
"path" : "ClaimResponse.item.adjudication.category",
"short" : "Type of adjudication information",
"definition" : "A code to indicate the information type of this adjudication record. Information types may include the value submitted, maximum values or percentages allowed or payable under the plan, amounts that: the patient is responsible for in aggregate or pertaining to this item; amounts paid by other coverages; and, the benefit payable for this item.",
"comment" : "For example codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.",
"requirements" : "Needed to enable understanding of the context of the other information in the adjudication.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClaimResponse.item.adjudication.category",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Adjudication"
}],
"strength" : "example",
"description" : "The adjudication codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/adjudication"
}
},
{
"id" : "ClaimResponse.item.adjudication.reason",
"path" : "ClaimResponse.item.adjudication.reason",
"short" : "Explanation of adjudication outcome",
"definition" : "A code supporting the understanding of the adjudication result and explaining variance from expected amount.",
"comment" : "For example may indicate that the funds for this benefit type have been exhausted.",
"requirements" : "To support understanding of variance from adjudication expectations.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.item.adjudication.reason",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdjudicationReason"
}],
"strength" : "example",
"description" : "The adjudication reason codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/adjudication-reason"
}
},
{
"id" : "ClaimResponse.item.adjudication.amount",
"path" : "ClaimResponse.item.adjudication.amount",
"short" : "Monetary amount",
"definition" : "Monetary amount associated with the category.",
"comment" : "For example: amount submitted, eligible amount, co-payment, and benefit payable.",
"requirements" : "Most adjuciation categories convey a monetary amount.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.item.adjudication.amount",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Money"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.item.adjudication.value",
"path" : "ClaimResponse.item.adjudication.value",
"short" : "Non-monetary value",
"definition" : "A non-monetary value associated with the category. Mutually exclusive to the amount element above.",
"comment" : "For example: eligible percentage or co-payment percentage.",
"requirements" : "Some adjudication categories convey a percentage or a fixed value.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.item.adjudication.value",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.item.detail",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "ItemDetail"
}],
"path" : "ClaimResponse.item.detail",
"short" : "Adjudication for claim details",
"definition" : "A claim detail. Either a simple (a product or service) or a 'group' of sub-details which are simple items.",
"requirements" : "The adjudication for details provided on the claim.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.item.detail",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.item.detail.id",
"path" : "ClaimResponse.item.detail.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClaimResponse.item.detail.extension",
"path" : "ClaimResponse.item.detail.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClaimResponse.item.detail.modifierExtension",
"path" : "ClaimResponse.item.detail.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ClaimResponse.item.detail.detailSequence",
"path" : "ClaimResponse.item.detail.detailSequence",
"short" : "Claim detail instance identifier",
"definition" : "A number to uniquely reference the claim detail entry.",
"requirements" : "Necessary to provide a mechanism to link the adjudication result to the submitted claim detail.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClaimResponse.item.detail.detailSequence",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.item.detail.noteNumber",
"path" : "ClaimResponse.item.detail.noteNumber",
"short" : "Applicable note numbers",
"definition" : "The numbers associated with notes below which apply to the adjudication of this item.",
"requirements" : "Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.item.detail.noteNumber",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.item.detail.adjudication",
"path" : "ClaimResponse.item.detail.adjudication",
"short" : "Detail level adjudication details",
"definition" : "The adjudication results.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "ClaimResponse.item.detail.adjudication",
"min" : 1,
"max" : "*"
},
"contentReference" : "#ClaimResponse.item.adjudication",
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.item.detail.subDetail",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "SubDetail"
}],
"path" : "ClaimResponse.item.detail.subDetail",
"short" : "Adjudication for claim sub-details",
"definition" : "A sub-detail adjudication of a simple product or service.",
"requirements" : "The adjudication for sub-details provided on the claim.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.item.detail.subDetail",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.item.detail.subDetail.id",
"path" : "ClaimResponse.item.detail.subDetail.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClaimResponse.item.detail.subDetail.extension",
"path" : "ClaimResponse.item.detail.subDetail.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClaimResponse.item.detail.subDetail.modifierExtension",
"path" : "ClaimResponse.item.detail.subDetail.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ClaimResponse.item.detail.subDetail.subDetailSequence",
"path" : "ClaimResponse.item.detail.subDetail.subDetailSequence",
"short" : "Claim sub-detail instance identifier",
"definition" : "A number to uniquely reference the claim sub-detail entry.",
"requirements" : "Necessary to provide a mechanism to link the adjudication result to the submitted claim sub-detail.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClaimResponse.item.detail.subDetail.subDetailSequence",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.item.detail.subDetail.noteNumber",
"path" : "ClaimResponse.item.detail.subDetail.noteNumber",
"short" : "Applicable note numbers",
"definition" : "The numbers associated with notes below which apply to the adjudication of this item.",
"requirements" : "Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.item.detail.subDetail.noteNumber",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.item.detail.subDetail.adjudication",
"path" : "ClaimResponse.item.detail.subDetail.adjudication",
"short" : "Subdetail level adjudication details",
"definition" : "The adjudication results.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.item.detail.subDetail.adjudication",
"min" : 0,
"max" : "*"
},
"contentReference" : "#ClaimResponse.item.adjudication",
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.addItem",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "AddedItem"
}],
"path" : "ClaimResponse.addItem",
"short" : "Insurer added line items",
"definition" : "The first-tier service adjudications for payor added product or service lines.",
"requirements" : "Insurers may redefine the provided product or service or may package and/or decompose groups of products and services. The addItems allows the insurer to provide their line item list with linkage to the submitted items/details/sub-details. In a preauthorization the insurer may use the addItem structure to provide additional information on authorized products and services.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.addItem",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.addItem.id",
"path" : "ClaimResponse.addItem.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClaimResponse.addItem.extension",
"path" : "ClaimResponse.addItem.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClaimResponse.addItem.modifierExtension",
"path" : "ClaimResponse.addItem.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ClaimResponse.addItem.itemSequence",
"path" : "ClaimResponse.addItem.itemSequence",
"short" : "Item sequence number",
"definition" : "Claim items which this service line is intended to replace.",
"requirements" : "Provides references to the claim items.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.addItem.itemSequence",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.addItem.detailSequence",
"path" : "ClaimResponse.addItem.detailSequence",
"short" : "Detail sequence number",
"definition" : "The sequence number of the details within the claim item which this line is intended to replace.",
"requirements" : "Provides references to the claim details within the claim item.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.addItem.detailSequence",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.addItem.subdetailSequence",
"path" : "ClaimResponse.addItem.subdetailSequence",
"short" : "Subdetail sequence number",
"definition" : "The sequence number of the sub-details within the details within the claim item which this line is intended to replace.",
"requirements" : "Provides references to the claim sub-details within the claim detail.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.addItem.subdetailSequence",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.addItem.provider",
"path" : "ClaimResponse.addItem.provider",
"short" : "Authorized providers",
"definition" : "The providers who are authorized for the services rendered to the patient.",
"requirements" : "Insurer may provide authorization specifically to a restricted set of providers rather than an open authorization.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.addItem.provider",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.source"
}]
},
{
"id" : "ClaimResponse.addItem.productOrService",
"path" : "ClaimResponse.addItem.productOrService",
"short" : "Billing, service, product, or drug code",
"definition" : "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.",
"comment" : "If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.",
"requirements" : "Necessary to state what was provided or done.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClaimResponse.addItem.productOrService",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceProduct"
}],
"strength" : "example",
"description" : "Allowable service and product codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-uscls"
}
},
{
"id" : "ClaimResponse.addItem.modifier",
"path" : "ClaimResponse.addItem.modifier",
"short" : "Service/Product billing modifiers",
"definition" : "Item typification or modifiers codes to convey additional context for the product or service.",
"comment" : "For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours.",
"requirements" : "To support inclusion of the item for adjudication or to charge an elevated fee.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.addItem.modifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Modifiers"
}],
"strength" : "example",
"description" : "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-modifiers"
},
"mapping" : [{
"identity" : "rim",
"map" : "24.C, 24.D mods"
}]
},
{
"id" : "ClaimResponse.addItem.programCode",
"path" : "ClaimResponse.addItem.programCode",
"short" : "Program the product or service is provided under",
"definition" : "Identifies the program under which this may be recovered.",
"comment" : "For example: Neonatal program, child dental program or drug users recovery program.",
"requirements" : "Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.addItem.programCode",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProgramCode"
}],
"strength" : "example",
"description" : "Program specific reason codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-program-code"
},
"mapping" : [{
"identity" : "rim",
"map" : "24.H"
}]
},
{
"id" : "ClaimResponse.addItem.serviced[x]",
"path" : "ClaimResponse.addItem.serviced[x]",
"short" : "Date or dates of service or product delivery",
"definition" : "The date or dates when the service or product was supplied, performed or completed.",
"requirements" : "Needed to determine whether the service or product was provided during the term of the insurance coverage.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.addItem.serviced[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
},
{
"code" : "Period"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "rim",
"map" : "24.A"
}]
},
{
"id" : "ClaimResponse.addItem.location[x]",
"path" : "ClaimResponse.addItem.location[x]",
"short" : "Place of service or where product was supplied",
"definition" : "Where the product or service was provided.",
"requirements" : "The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.addItem.location[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Address"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServicePlace"
}],
"strength" : "example",
"description" : "Place of service: pharmacy, school, prison, etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-place"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.where[x]"
},
{
"identity" : "rim",
"map" : "24.B"
}]
},
{
"id" : "ClaimResponse.addItem.quantity",
"path" : "ClaimResponse.addItem.quantity",
"short" : "Count of products or services",
"definition" : "The number of repetitions of a service or product.",
"requirements" : "Required when the product or service code does not convey the quantity provided.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.addItem.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "24.G"
}]
},
{
"id" : "ClaimResponse.addItem.unitPrice",
"path" : "ClaimResponse.addItem.unitPrice",
"short" : "Fee, charge or cost per item",
"definition" : "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.",
"requirements" : "The amount charged to the patient by the provider for a single unit.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.addItem.unitPrice",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Money"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.addItem.factor",
"path" : "ClaimResponse.addItem.factor",
"short" : "Price scaling factor",
"definition" : "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"comment" : "To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).",
"requirements" : "When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.addItem.factor",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.addItem.net",
"path" : "ClaimResponse.addItem.net",
"short" : "Total item cost",
"definition" : "The quantity times the unit price for an additional service or product or charge.",
"comment" : "For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.",
"requirements" : "Provides the total amount claimed for the group (if a grouper) or the line item.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.addItem.net",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Money"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "24.F"
}]
},
{
"id" : "ClaimResponse.addItem.bodySite",
"path" : "ClaimResponse.addItem.bodySite",
"short" : "Anatomical location",
"definition" : "Physical service site on the patient (limb, tooth, etc.).",
"comment" : "For example: Providing a tooth code allows an insurer to identify a provider performing a filling on a tooth that was previously removed.",
"requirements" : "Allows insurer to validate specific procedures.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.addItem.bodySite",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "OralSites"
}],
"strength" : "example",
"description" : "The code for the teeth, quadrant, sextant and arch.",
"valueSet" : "http://hl7.org/fhir/ValueSet/tooth"
}
},
{
"id" : "ClaimResponse.addItem.subSite",
"path" : "ClaimResponse.addItem.subSite",
"short" : "Anatomical sub-location",
"definition" : "A region or surface of the bodySite, e.g. limb region or tooth surface(s).",
"requirements" : "Allows insurer to validate specific procedures.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.addItem.subSite",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Surface"
}],
"strength" : "example",
"description" : "The code for the tooth surface and surface combinations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/surface"
}
},
{
"id" : "ClaimResponse.addItem.noteNumber",
"path" : "ClaimResponse.addItem.noteNumber",
"short" : "Applicable note numbers",
"definition" : "The numbers associated with notes below which apply to the adjudication of this item.",
"requirements" : "Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.addItem.noteNumber",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.addItem.adjudication",
"path" : "ClaimResponse.addItem.adjudication",
"short" : "Added items adjudication",
"definition" : "The adjudication results.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "ClaimResponse.addItem.adjudication",
"min" : 1,
"max" : "*"
},
"contentReference" : "#ClaimResponse.item.adjudication",
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.addItem.detail",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "AddedItemDetail"
}],
"path" : "ClaimResponse.addItem.detail",
"short" : "Insurer added line details",
"definition" : "The second-tier service adjudications for payor added services.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.addItem.detail",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.addItem.detail.id",
"path" : "ClaimResponse.addItem.detail.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClaimResponse.addItem.detail.extension",
"path" : "ClaimResponse.addItem.detail.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClaimResponse.addItem.detail.modifierExtension",
"path" : "ClaimResponse.addItem.detail.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ClaimResponse.addItem.detail.productOrService",
"path" : "ClaimResponse.addItem.detail.productOrService",
"short" : "Billing, service, product, or drug code",
"definition" : "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.",
"comment" : "If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.",
"requirements" : "Necessary to state what was provided or done.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClaimResponse.addItem.detail.productOrService",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceProduct"
}],
"strength" : "example",
"description" : "Allowable service and product codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-uscls"
}
},
{
"id" : "ClaimResponse.addItem.detail.modifier",
"path" : "ClaimResponse.addItem.detail.modifier",
"short" : "Service/Product billing modifiers",
"definition" : "Item typification or modifiers codes to convey additional context for the product or service.",
"comment" : "For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours.",
"requirements" : "To support inclusion of the item for adjudication or to charge an elevated fee.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.addItem.detail.modifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Modifiers"
}],
"strength" : "example",
"description" : "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-modifiers"
},
"mapping" : [{
"identity" : "rim",
"map" : "24.C, 24.D mods"
}]
},
{
"id" : "ClaimResponse.addItem.detail.quantity",
"path" : "ClaimResponse.addItem.detail.quantity",
"short" : "Count of products or services",
"definition" : "The number of repetitions of a service or product.",
"requirements" : "Required when the product or service code does not convey the quantity provided.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.addItem.detail.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "24.G"
}]
},
{
"id" : "ClaimResponse.addItem.detail.unitPrice",
"path" : "ClaimResponse.addItem.detail.unitPrice",
"short" : "Fee, charge or cost per item",
"definition" : "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.",
"requirements" : "The amount charged to the patient by the provider for a single unit.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.addItem.detail.unitPrice",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Money"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.addItem.detail.factor",
"path" : "ClaimResponse.addItem.detail.factor",
"short" : "Price scaling factor",
"definition" : "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"comment" : "To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).",
"requirements" : "When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.addItem.detail.factor",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.addItem.detail.net",
"path" : "ClaimResponse.addItem.detail.net",
"short" : "Total item cost",
"definition" : "The quantity times the unit price for an additional service or product or charge.",
"comment" : "For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.",
"requirements" : "Provides the total amount claimed for the group (if a grouper) or the line item.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.addItem.detail.net",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Money"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "24.F"
}]
},
{
"id" : "ClaimResponse.addItem.detail.noteNumber",
"path" : "ClaimResponse.addItem.detail.noteNumber",
"short" : "Applicable note numbers",
"definition" : "The numbers associated with notes below which apply to the adjudication of this item.",
"requirements" : "Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.addItem.detail.noteNumber",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.addItem.detail.adjudication",
"path" : "ClaimResponse.addItem.detail.adjudication",
"short" : "Added items detail adjudication",
"definition" : "The adjudication results.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "ClaimResponse.addItem.detail.adjudication",
"min" : 1,
"max" : "*"
},
"contentReference" : "#ClaimResponse.item.adjudication",
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.addItem.detail.subDetail",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "AddedItemSubDetail"
}],
"path" : "ClaimResponse.addItem.detail.subDetail",
"short" : "Insurer added line items",
"definition" : "The third-tier service adjudications for payor added services.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.addItem.detail.subDetail",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.addItem.detail.subDetail.id",
"path" : "ClaimResponse.addItem.detail.subDetail.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClaimResponse.addItem.detail.subDetail.extension",
"path" : "ClaimResponse.addItem.detail.subDetail.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClaimResponse.addItem.detail.subDetail.modifierExtension",
"path" : "ClaimResponse.addItem.detail.subDetail.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ClaimResponse.addItem.detail.subDetail.productOrService",
"path" : "ClaimResponse.addItem.detail.subDetail.productOrService",
"short" : "Billing, service, product, or drug code",
"definition" : "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.",
"comment" : "If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.",
"requirements" : "Necessary to state what was provided or done.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClaimResponse.addItem.detail.subDetail.productOrService",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceProduct"
}],
"strength" : "example",
"description" : "Allowable service and product codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-uscls"
}
},
{
"id" : "ClaimResponse.addItem.detail.subDetail.modifier",
"path" : "ClaimResponse.addItem.detail.subDetail.modifier",
"short" : "Service/Product billing modifiers",
"definition" : "Item typification or modifiers codes to convey additional context for the product or service.",
"comment" : "For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours.",
"requirements" : "To support inclusion of the item for adjudication or to charge an elevated fee.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.addItem.detail.subDetail.modifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Modifiers"
}],
"strength" : "example",
"description" : "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-modifiers"
},
"mapping" : [{
"identity" : "rim",
"map" : "24.C, 24.D mods"
}]
},
{
"id" : "ClaimResponse.addItem.detail.subDetail.quantity",
"path" : "ClaimResponse.addItem.detail.subDetail.quantity",
"short" : "Count of products or services",
"definition" : "The number of repetitions of a service or product.",
"requirements" : "Required when the product or service code does not convey the quantity provided.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.addItem.detail.subDetail.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "24.G"
}]
},
{
"id" : "ClaimResponse.addItem.detail.subDetail.unitPrice",
"path" : "ClaimResponse.addItem.detail.subDetail.unitPrice",
"short" : "Fee, charge or cost per item",
"definition" : "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.",
"requirements" : "The amount charged to the patient by the provider for a single unit.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.addItem.detail.subDetail.unitPrice",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Money"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.addItem.detail.subDetail.factor",
"path" : "ClaimResponse.addItem.detail.subDetail.factor",
"short" : "Price scaling factor",
"definition" : "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"comment" : "To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).",
"requirements" : "When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.addItem.detail.subDetail.factor",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.addItem.detail.subDetail.net",
"path" : "ClaimResponse.addItem.detail.subDetail.net",
"short" : "Total item cost",
"definition" : "The quantity times the unit price for an additional service or product or charge.",
"comment" : "For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.",
"requirements" : "Provides the total amount claimed for the group (if a grouper) or the line item.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.addItem.detail.subDetail.net",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Money"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "24.F"
}]
},
{
"id" : "ClaimResponse.addItem.detail.subDetail.noteNumber",
"path" : "ClaimResponse.addItem.detail.subDetail.noteNumber",
"short" : "Applicable note numbers",
"definition" : "The numbers associated with notes below which apply to the adjudication of this item.",
"requirements" : "Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.addItem.detail.subDetail.noteNumber",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.addItem.detail.subDetail.adjudication",
"path" : "ClaimResponse.addItem.detail.subDetail.adjudication",
"short" : "Added items detail adjudication",
"definition" : "The adjudication results.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "ClaimResponse.addItem.detail.subDetail.adjudication",
"min" : 1,
"max" : "*"
},
"contentReference" : "#ClaimResponse.item.adjudication",
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.adjudication",
"path" : "ClaimResponse.adjudication",
"short" : "Header-level adjudication",
"definition" : "The adjudication results which are presented at the header level rather than at the line-item or add-item levels.",
"requirements" : "Some insurers will receive line-items but provide the adjudication only at a summary or header-level.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.adjudication",
"min" : 0,
"max" : "*"
},
"contentReference" : "#ClaimResponse.item.adjudication",
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.total",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Total"
}],
"path" : "ClaimResponse.total",
"short" : "Adjudication totals",
"definition" : "Categorized monetary totals for the adjudication.",
"comment" : "Totals for amounts submitted, co-pays, benefits payable etc.",
"requirements" : "To provide the requestor with financial totals by category for the adjudication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.total",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ClaimResponse.total.id",
"path" : "ClaimResponse.total.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClaimResponse.total.extension",
"path" : "ClaimResponse.total.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClaimResponse.total.modifierExtension",
"path" : "ClaimResponse.total.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ClaimResponse.total.category",
"path" : "ClaimResponse.total.category",
"short" : "Type of adjudication information",
"definition" : "A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.",
"comment" : "For example codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.",
"requirements" : "Needed to convey the type of total provided.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClaimResponse.total.category",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Adjudication"
}],
"strength" : "example",
"description" : "The adjudication codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/adjudication"
}
},
{
"id" : "ClaimResponse.total.amount",
"path" : "ClaimResponse.total.amount",
"short" : "Financial total for the category",
"definition" : "Monetary total amount associated with the category.",
"requirements" : "Needed to convey the total monetary amount.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClaimResponse.total.amount",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Money"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ClaimResponse.payment",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Payment"
}],
"path" : "ClaimResponse.payment",
"short" : "Payment Details",
"definition" : "Payment details for the adjudication of the claim.",
"requirements" : "Needed to convey references to the financial instrument that has been used if payment has been made.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.payment",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.payment.id",
"path" : "ClaimResponse.payment.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClaimResponse.payment.extension",
"path" : "ClaimResponse.payment.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClaimResponse.payment.modifierExtension",
"path" : "ClaimResponse.payment.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ClaimResponse.payment.type",
"path" : "ClaimResponse.payment.type",
"short" : "Partial or complete payment",
"definition" : "Whether this represents partial or complete payment of the benefits payable.",
"requirements" : "To advise the requestor when the insurer believes all payments to have been completed.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClaimResponse.payment.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PaymentType"
}],
"strength" : "example",
"description" : "The type (partial, complete) of the payment.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-paymenttype"
}
},
{
"id" : "ClaimResponse.payment.adjustment",
"path" : "ClaimResponse.payment.adjustment",
"short" : "Payment adjustment for non-claim issues",
"definition" : "Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication.",
"comment" : "Insurers will deduct amounts owing from the provider (adjustment), such as a prior overpayment, from the amount owing to the provider (benefits payable) when payment is made to the provider.",
"requirements" : "To advise the requestor of adjustments applied to the payment.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.payment.adjustment",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Money"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.payment.adjustmentReason",
"path" : "ClaimResponse.payment.adjustmentReason",
"short" : "Explanation for the adjustment",
"definition" : "Reason for the payment adjustment.",
"requirements" : "Needed to clarify the monetary adjustment.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.payment.adjustmentReason",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PaymentAdjustmentReason"
}],
"strength" : "example",
"description" : "Payment Adjustment reason codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/payment-adjustment-reason"
}
},
{
"id" : "ClaimResponse.payment.date",
"path" : "ClaimResponse.payment.date",
"short" : "Expected date of payment",
"definition" : "Estimated date the payment will be issued or the actual issue date of payment.",
"requirements" : "To advise the payee when payment can be expected.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.payment.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.payment.amount",
"path" : "ClaimResponse.payment.amount",
"short" : "Payable amount after adjustment",
"definition" : "Benefits payable less any payment adjustment.",
"requirements" : "Needed to provide the actual payment amount.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClaimResponse.payment.amount",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Money"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.payment.identifier",
"path" : "ClaimResponse.payment.identifier",
"short" : "Business identifier for the payment",
"definition" : "Issuer's unique identifier for the payment instrument.",
"comment" : "For example: EFT number or check number.",
"requirements" : "Enable the receiver to reconcile when payment received.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.payment.identifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.fundsReserve",
"path" : "ClaimResponse.fundsReserve",
"short" : "Funds reserved status",
"definition" : "A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.",
"comment" : "Fund would be release by a future claim quoting the preAuthRef of this response. Examples of values include: provider, patient, none.",
"requirements" : "Needed to advise the submitting provider on whether the rquest for reservation of funds has been honored.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.fundsReserve",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FundsReserve"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "example",
"description" : "For whom funds are to be reserved: (Patient, Provider, None).",
"valueSet" : "http://hl7.org/fhir/ValueSet/fundsreserve"
}
},
{
"id" : "ClaimResponse.formCode",
"path" : "ClaimResponse.formCode",
"short" : "Printed form identifier",
"definition" : "A code for the form to be used for printing the content.",
"comment" : "May be needed to identify specific jurisdictional forms.",
"requirements" : "Needed to specify the specific form used for producing output for this response.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.formCode",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Forms"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "example",
"description" : "The forms codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/forms"
}
},
{
"id" : "ClaimResponse.form",
"path" : "ClaimResponse.form",
"short" : "Printed reference or actual form",
"definition" : "The actual form, by reference or inclusion, for printing the content or an EOB.",
"comment" : "Needed to permit insurers to include the actual form.",
"requirements" : "Needed to include the specific form used for producing output for this response.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.form",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Attachment"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.processNote",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Note"
}],
"path" : "ClaimResponse.processNote",
"short" : "Note concerning adjudication",
"definition" : "A note that describes or explains adjudication results in a human readable form.",
"requirements" : "Provides the insurer specific textual explanations associated with the processing.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.processNote",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.processNote.id",
"path" : "ClaimResponse.processNote.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClaimResponse.processNote.extension",
"path" : "ClaimResponse.processNote.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClaimResponse.processNote.modifierExtension",
"path" : "ClaimResponse.processNote.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ClaimResponse.processNote.number",
"path" : "ClaimResponse.processNote.number",
"short" : "Note instance identifier",
"definition" : "A number to uniquely identify a note entry.",
"requirements" : "Necessary to provide a mechanism to link from adjudications.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.processNote.number",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.processNote.type",
"path" : "ClaimResponse.processNote.type",
"short" : "display | print | printoper",
"definition" : "The business purpose of the note text.",
"requirements" : "To convey the expectation for when the text is used.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.processNote.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NoteType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The presentation types of notes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/note-type|4.0.0"
}
},
{
"id" : "ClaimResponse.processNote.text",
"path" : "ClaimResponse.processNote.text",
"short" : "Note explanatory text",
"definition" : "The explanation or description associated with the processing.",
"requirements" : "Required to provide human readable explanation.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClaimResponse.processNote.text",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.processNote.language",
"path" : "ClaimResponse.processNote.language",
"short" : "Language of the text",
"definition" : "A code to define the language used in the text of the note.",
"comment" : "Only required if the language is different from the resource language.",
"requirements" : "Note text may vary from the resource defined language.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.processNote.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "ClaimResponse.communicationRequest",
"path" : "ClaimResponse.communicationRequest",
"short" : "Request for additional information",
"definition" : "Request for additional supporting or authorizing information.",
"comment" : "For example: professional reports, documents, images, clinical resources, or accident reports.",
"requirements" : "Need to communicate insurer request for additional information required to support the adjudication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.communicationRequest",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CommunicationRequest"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.insurance",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Insurance"
}],
"path" : "ClaimResponse.insurance",
"short" : "Patient insurance information",
"definition" : "Financial instruments for reimbursement for the health care products and services specified on the claim.",
"comment" : "All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.",
"requirements" : "At least one insurer is required for a claim to be a claim.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.insurance",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Coverage"
}]
},
{
"id" : "ClaimResponse.insurance.id",
"path" : "ClaimResponse.insurance.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClaimResponse.insurance.extension",
"path" : "ClaimResponse.insurance.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClaimResponse.insurance.modifierExtension",
"path" : "ClaimResponse.insurance.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ClaimResponse.insurance.sequence",
"path" : "ClaimResponse.insurance.sequence",
"short" : "Insurance instance identifier",
"definition" : "A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.",
"requirements" : "To maintain order of the coverages.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClaimResponse.insurance.sequence",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.insurance.focal",
"path" : "ClaimResponse.insurance.focal",
"short" : "Coverage to be used for adjudication",
"definition" : "A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.",
"comment" : "A patient may (will) have multiple insurance policies which provide reimbursement for healthcare services and products. For example a person may also be covered by their spouse's policy and both appear in the list (and may be from the same insurer). This flag will be set to true for only one of the listed policies and that policy will be used for adjudicating this claim. Other claims would be created to request adjudication against the other listed policies.",
"requirements" : "To identify which coverage in the list is being used to adjudicate this claim.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClaimResponse.insurance.focal",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.insurance.coverage",
"path" : "ClaimResponse.insurance.coverage",
"short" : "Insurance information",
"definition" : "Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.",
"requirements" : "Required to allow the adjudicator to locate the correct policy and history within their information system.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClaimResponse.insurance.coverage",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Coverage"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.insurance.businessArrangement",
"path" : "ClaimResponse.insurance.businessArrangement",
"short" : "Additional provider contract number",
"definition" : "A business agreement number established between the provider and the insurer for special business processing purposes.",
"requirements" : "Providers may have multiple business arrangements with a given insurer and must supply the specific contract number for adjudication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.insurance.businessArrangement",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.insurance.claimResponse",
"path" : "ClaimResponse.insurance.claimResponse",
"short" : "Adjudication results",
"definition" : "The result of the adjudication of the line items for the Coverage specified in this insurance.",
"comment" : "Must not be specified when 'focal=true' for this insurance.",
"requirements" : "An insurer need the adjudication results from prior insurers to determine the outstanding balance remaining by item for the items in the curent claim.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.insurance.claimResponse",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ClaimResponse"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.error",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Error"
}],
"path" : "ClaimResponse.error",
"short" : "Processing errors",
"definition" : "Errors encountered during the processing of the adjudication.",
"comment" : "If the request contains errors then an error element should be provided and no adjudication related sections (item, addItem, or payment) should be present.",
"requirements" : "Need to communicate processing issues to the requestor.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClaimResponse.error",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.error.id",
"path" : "ClaimResponse.error.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClaimResponse.error.extension",
"path" : "ClaimResponse.error.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClaimResponse.error.modifierExtension",
"path" : "ClaimResponse.error.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ClaimResponse.error.itemSequence",
"path" : "ClaimResponse.error.itemSequence",
"short" : "Item sequence number",
"definition" : "The sequence number of the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.",
"requirements" : "Provides references to the claim items.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.error.itemSequence",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.error.detailSequence",
"path" : "ClaimResponse.error.detailSequence",
"short" : "Detail sequence number",
"definition" : "The sequence number of the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.",
"requirements" : "Provides references to the claim details within the claim item.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.error.detailSequence",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.error.subDetailSequence",
"path" : "ClaimResponse.error.subDetailSequence",
"short" : "Subdetail sequence number",
"definition" : "The sequence number of the sub-detail within the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.",
"requirements" : "Provides references to the claim sub-details within the claim detail.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClaimResponse.error.subDetailSequence",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "positiveInt"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClaimResponse.error.code",
"path" : "ClaimResponse.error.code",
"short" : "Error code detailing processing issues",
"definition" : "An error code, from a specified code system, which details why the claim could not be adjudicated.",
"requirements" : "Required to convey processing errors.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClaimResponse.error.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdjudicationError"
}],
"strength" : "example",
"description" : "The adjudication error codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/adjudication-error"
}
}]
},
"differential" : {
"element" : [{
"id" : "ClaimResponse",
"path" : "ClaimResponse",
"short" : "Response to a claim predetermination or preauthorization",
"definition" : "This resource provides the adjudication details from the processing of a Claim resource.",
"alias" : ["Remittance Advice"],
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Event"
}]
},
{
"id" : "ClaimResponse.identifier",
"path" : "ClaimResponse.identifier",
"short" : "Business Identifier for a claim response",
"definition" : "A unique identifier assigned to this claim response.",
"requirements" : "Allows claim responses to be distinguished and referenced.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "ClaimResponse.status",
"path" : "ClaimResponse.status",
"short" : "active | cancelled | draft | entered-in-error",
"definition" : "The status of the resource instance.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"requirements" : "Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClaimResponseStatus"
}],
"strength" : "required",
"description" : "A code specifying the state of the resource instance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/fm-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "ClaimResponse.type",
"path" : "ClaimResponse.type",
"short" : "More granular claim type",
"definition" : "A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.",
"comment" : "This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type.",
"requirements" : "Some jurisdictions need a finer grained claim type for routing and adjudication.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClaimType"
}],
"strength" : "extensible",
"description" : "The type or discipline-style of the claim.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "ClaimResponse.subType",
"path" : "ClaimResponse.subType",
"short" : "More granular claim type",
"definition" : "A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.",
"comment" : "This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type.",
"requirements" : "Some jurisdictions need a finer grained claim type for routing and adjudication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClaimSubType"
}],
"strength" : "example",
"description" : "A more granular claim typecode.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-subtype"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "ClaimResponse.use",
"path" : "ClaimResponse.use",
"short" : "claim | preauthorization | predetermination",
"definition" : "A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.",
"requirements" : "This element is required to understand the nature of the request for adjudication.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Use"
}],
"strength" : "required",
"description" : "Claim, preauthorization, predetermination.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-use|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "ClaimResponse.patient",
"path" : "ClaimResponse.patient",
"short" : "The recipient of the products and services",
"definition" : "The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought.",
"requirements" : "The patient must be supplied to the insurer so that confirmation of coverage and service hstory may be considered as part of the authorization and/or adjudiction.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "ClaimResponse.created",
"path" : "ClaimResponse.created",
"short" : "Response creation date",
"definition" : "The date this resource was created.",
"requirements" : "Need to record a timestamp for use by both the recipient and the issuer.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "ClaimResponse.insurer",
"path" : "ClaimResponse.insurer",
"short" : "Party responsible for reimbursement",
"definition" : "The party responsible for authorization, adjudication and reimbursement.",
"requirements" : "To be a valid claim, preauthorization or predetermination there must be a party who is responsible for adjudicating the contents against a policy which provides benefits for the patient.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
}]
},
{
"id" : "ClaimResponse.requestor",
"path" : "ClaimResponse.requestor",
"short" : "Party responsible for the claim",
"definition" : "The provider which is responsible for the claim, predetermination or preauthorization.",
"comment" : "Typically this field would be 1..1 where this party is responsible for the claim but not necessarily professionally responsible for the provision of the individual products and services listed below.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.source"
}]
},
{
"id" : "ClaimResponse.request",
"path" : "ClaimResponse.request",
"short" : "Id of resource triggering adjudication",
"definition" : "Original request resource reference.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Claim"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
}]
},
{
"id" : "ClaimResponse.outcome",
"path" : "ClaimResponse.outcome",
"short" : "queued | complete | error | partial",
"definition" : "The outcome of the claim, predetermination, or preauthorization processing.",
"comment" : "The resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete).",
"requirements" : "To advise the requestor of an overall processing outcome.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RemittanceOutcome"
}],
"strength" : "required",
"description" : "The result of the claim processing.",
"valueSet" : "http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.0"
}
},
{
"id" : "ClaimResponse.disposition",
"path" : "ClaimResponse.disposition",
"short" : "Disposition Message",
"definition" : "A human readable description of the status of the adjudication.",
"requirements" : "Provided for user display.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
}]
},
{
"id" : "ClaimResponse.preAuthRef",
"path" : "ClaimResponse.preAuthRef",
"short" : "Preauthorization reference",
"definition" : "Reference from the Insurer which is used in later communications which refers to this adjudication.",
"comment" : "This value is only present on preauthorization adjudications.",
"requirements" : "On subsequent claims, the insurer may require the provider to quote this value.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "ClaimResponse.preAuthPeriod",
"path" : "ClaimResponse.preAuthPeriod",
"short" : "Preauthorization reference effective period",
"definition" : "The time frame during which this authorization is effective.",
"requirements" : "To convey to the provider when the authorized products and services must be supplied for the authorized adjudication to apply.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}]
},
{
"id" : "ClaimResponse.payeeType",
"path" : "ClaimResponse.payeeType",
"short" : "Party to be paid any benefits payable",
"definition" : "Type of Party to be reimbursed: subscriber, provider, other.",
"requirements" : "Need to know who should receive payment with the most common situations being the Provider (assignment of benefits) or the Subscriber.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PayeeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "example",
"description" : "A code for the party to be reimbursed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/payeetype"
}
},
{
"id" : "ClaimResponse.item",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Item"
}],
"path" : "ClaimResponse.item",
"short" : "Adjudication for claim line items",
"definition" : "A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.",
"requirements" : "The adjudication for items provided on the claim.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "ClaimResponse.item.itemSequence",
"path" : "ClaimResponse.item.itemSequence",
"short" : "Claim item instance identifier",
"definition" : "A number to uniquely reference the claim item entries.",
"requirements" : "Necessary to provide a mechanism to link the adjudication result to the submitted claim item.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "ClaimResponse.item.noteNumber",
"path" : "ClaimResponse.item.noteNumber",
"short" : "Applicable note numbers",
"definition" : "The numbers associated with notes below which apply to the adjudication of this item.",
"requirements" : "Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "ClaimResponse.item.adjudication",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Adjudication"
}],
"path" : "ClaimResponse.item.adjudication",
"short" : "Adjudication details",
"definition" : "If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.",
"requirements" : "The adjudication results conveys the insurer's assessment of the item provided in the claim under the terms of the patient's insurance coverage.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "ClaimResponse.item.adjudication.category",
"path" : "ClaimResponse.item.adjudication.category",
"short" : "Type of adjudication information",
"definition" : "A code to indicate the information type of this adjudication record. Information types may include the value submitted, maximum values or percentages allowed or payable under the plan, amounts that: the patient is responsible for in aggregate or pertaining to this item; amounts paid by other coverages; and, the benefit payable for this item.",
"comment" : "For example codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.",
"requirements" : "Needed to enable understanding of the context of the other information in the adjudication.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Adjudication"
}],
"strength" : "example",
"description" : "The adjudication codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/adjudication"
}
},
{
"id" : "ClaimResponse.item.adjudication.reason",
"path" : "ClaimResponse.item.adjudication.reason",
"short" : "Explanation of adjudication outcome",
"definition" : "A code supporting the understanding of the adjudication result and explaining variance from expected amount.",
"comment" : "For example may indicate that the funds for this benefit type have been exhausted.",
"requirements" : "To support understanding of variance from adjudication expectations.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdjudicationReason"
}],
"strength" : "example",
"description" : "The adjudication reason codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/adjudication-reason"
}
},
{
"id" : "ClaimResponse.item.adjudication.amount",
"path" : "ClaimResponse.item.adjudication.amount",
"short" : "Monetary amount",
"definition" : "Monetary amount associated with the category.",
"comment" : "For example: amount submitted, eligible amount, co-payment, and benefit payable.",
"requirements" : "Most adjuciation categories convey a monetary amount.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}]
},
{
"id" : "ClaimResponse.item.adjudication.value",
"path" : "ClaimResponse.item.adjudication.value",
"short" : "Non-monetary value",
"definition" : "A non-monetary value associated with the category. Mutually exclusive to the amount element above.",
"comment" : "For example: eligible percentage or co-payment percentage.",
"requirements" : "Some adjudication categories convey a percentage or a fixed value.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}]
},
{
"id" : "ClaimResponse.item.detail",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "ItemDetail"
}],
"path" : "ClaimResponse.item.detail",
"short" : "Adjudication for claim details",
"definition" : "A claim detail. Either a simple (a product or service) or a 'group' of sub-details which are simple items.",
"requirements" : "The adjudication for details provided on the claim.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "ClaimResponse.item.detail.detailSequence",
"path" : "ClaimResponse.item.detail.detailSequence",
"short" : "Claim detail instance identifier",
"definition" : "A number to uniquely reference the claim detail entry.",
"requirements" : "Necessary to provide a mechanism to link the adjudication result to the submitted claim detail.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "ClaimResponse.item.detail.noteNumber",
"path" : "ClaimResponse.item.detail.noteNumber",
"short" : "Applicable note numbers",
"definition" : "The numbers associated with notes below which apply to the adjudication of this item.",
"requirements" : "Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "ClaimResponse.item.detail.adjudication",
"path" : "ClaimResponse.item.detail.adjudication",
"short" : "Detail level adjudication details",
"definition" : "The adjudication results.",
"min" : 1,
"max" : "*",
"contentReference" : "#ClaimResponse.item.adjudication"
},
{
"id" : "ClaimResponse.item.detail.subDetail",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "SubDetail"
}],
"path" : "ClaimResponse.item.detail.subDetail",
"short" : "Adjudication for claim sub-details",
"definition" : "A sub-detail adjudication of a simple product or service.",
"requirements" : "The adjudication for sub-details provided on the claim.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "ClaimResponse.item.detail.subDetail.subDetailSequence",
"path" : "ClaimResponse.item.detail.subDetail.subDetailSequence",
"short" : "Claim sub-detail instance identifier",
"definition" : "A number to uniquely reference the claim sub-detail entry.",
"requirements" : "Necessary to provide a mechanism to link the adjudication result to the submitted claim sub-detail.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "ClaimResponse.item.detail.subDetail.noteNumber",
"path" : "ClaimResponse.item.detail.subDetail.noteNumber",
"short" : "Applicable note numbers",
"definition" : "The numbers associated with notes below which apply to the adjudication of this item.",
"requirements" : "Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "ClaimResponse.item.detail.subDetail.adjudication",
"path" : "ClaimResponse.item.detail.subDetail.adjudication",
"short" : "Subdetail level adjudication details",
"definition" : "The adjudication results.",
"min" : 0,
"max" : "*",
"contentReference" : "#ClaimResponse.item.adjudication"
},
{
"id" : "ClaimResponse.addItem",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "AddedItem"
}],
"path" : "ClaimResponse.addItem",
"short" : "Insurer added line items",
"definition" : "The first-tier service adjudications for payor added product or service lines.",
"requirements" : "Insurers may redefine the provided product or service or may package and/or decompose groups of products and services. The addItems allows the insurer to provide their line item list with linkage to the submitted items/details/sub-details. In a preauthorization the insurer may use the addItem structure to provide additional information on authorized products and services.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "ClaimResponse.addItem.itemSequence",
"path" : "ClaimResponse.addItem.itemSequence",
"short" : "Item sequence number",
"definition" : "Claim items which this service line is intended to replace.",
"requirements" : "Provides references to the claim items.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "ClaimResponse.addItem.detailSequence",
"path" : "ClaimResponse.addItem.detailSequence",
"short" : "Detail sequence number",
"definition" : "The sequence number of the details within the claim item which this line is intended to replace.",
"requirements" : "Provides references to the claim details within the claim item.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "ClaimResponse.addItem.subdetailSequence",
"path" : "ClaimResponse.addItem.subdetailSequence",
"short" : "Subdetail sequence number",
"definition" : "The sequence number of the sub-details within the details within the claim item which this line is intended to replace.",
"requirements" : "Provides references to the claim sub-details within the claim detail.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "ClaimResponse.addItem.provider",
"path" : "ClaimResponse.addItem.provider",
"short" : "Authorized providers",
"definition" : "The providers who are authorized for the services rendered to the patient.",
"requirements" : "Insurer may provide authorization specifically to a restricted set of providers rather than an open authorization.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.source"
}]
},
{
"id" : "ClaimResponse.addItem.productOrService",
"path" : "ClaimResponse.addItem.productOrService",
"short" : "Billing, service, product, or drug code",
"definition" : "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.",
"comment" : "If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.",
"requirements" : "Necessary to state what was provided or done.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceProduct"
}],
"strength" : "example",
"description" : "Allowable service and product codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-uscls"
}
},
{
"id" : "ClaimResponse.addItem.modifier",
"path" : "ClaimResponse.addItem.modifier",
"short" : "Service/Product billing modifiers",
"definition" : "Item typification or modifiers codes to convey additional context for the product or service.",
"comment" : "For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours.",
"requirements" : "To support inclusion of the item for adjudication or to charge an elevated fee.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Modifiers"
}],
"strength" : "example",
"description" : "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-modifiers"
},
"mapping" : [{
"identity" : "rim",
"map" : "24.C, 24.D mods"
}]
},
{
"id" : "ClaimResponse.addItem.programCode",
"path" : "ClaimResponse.addItem.programCode",
"short" : "Program the product or service is provided under",
"definition" : "Identifies the program under which this may be recovered.",
"comment" : "For example: Neonatal program, child dental program or drug users recovery program.",
"requirements" : "Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProgramCode"
}],
"strength" : "example",
"description" : "Program specific reason codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-program-code"
},
"mapping" : [{
"identity" : "rim",
"map" : "24.H"
}]
},
{
"id" : "ClaimResponse.addItem.serviced[x]",
"path" : "ClaimResponse.addItem.serviced[x]",
"short" : "Date or dates of service or product delivery",
"definition" : "The date or dates when the service or product was supplied, performed or completed.",
"requirements" : "Needed to determine whether the service or product was provided during the term of the insurance coverage.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
},
{
"code" : "Period"
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "rim",
"map" : "24.A"
}]
},
{
"id" : "ClaimResponse.addItem.location[x]",
"path" : "ClaimResponse.addItem.location[x]",
"short" : "Place of service or where product was supplied",
"definition" : "Where the product or service was provided.",
"requirements" : "The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Address"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServicePlace"
}],
"strength" : "example",
"description" : "Place of service: pharmacy, school, prison, etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-place"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.where[x]"
},
{
"identity" : "rim",
"map" : "24.B"
}]
},
{
"id" : "ClaimResponse.addItem.quantity",
"path" : "ClaimResponse.addItem.quantity",
"short" : "Count of products or services",
"definition" : "The number of repetitions of a service or product.",
"requirements" : "Required when the product or service code does not convey the quantity provided.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mapping" : [{
"identity" : "rim",
"map" : "24.G"
}]
},
{
"id" : "ClaimResponse.addItem.unitPrice",
"path" : "ClaimResponse.addItem.unitPrice",
"short" : "Fee, charge or cost per item",
"definition" : "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.",
"requirements" : "The amount charged to the patient by the provider for a single unit.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}]
},
{
"id" : "ClaimResponse.addItem.factor",
"path" : "ClaimResponse.addItem.factor",
"short" : "Price scaling factor",
"definition" : "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"comment" : "To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).",
"requirements" : "When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}]
},
{
"id" : "ClaimResponse.addItem.net",
"path" : "ClaimResponse.addItem.net",
"short" : "Total item cost",
"definition" : "The quantity times the unit price for an additional service or product or charge.",
"comment" : "For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.",
"requirements" : "Provides the total amount claimed for the group (if a grouper) or the line item.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}],
"mapping" : [{
"identity" : "rim",
"map" : "24.F"
}]
},
{
"id" : "ClaimResponse.addItem.bodySite",
"path" : "ClaimResponse.addItem.bodySite",
"short" : "Anatomical location",
"definition" : "Physical service site on the patient (limb, tooth, etc.).",
"comment" : "For example: Providing a tooth code allows an insurer to identify a provider performing a filling on a tooth that was previously removed.",
"requirements" : "Allows insurer to validate specific procedures.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "OralSites"
}],
"strength" : "example",
"description" : "The code for the teeth, quadrant, sextant and arch.",
"valueSet" : "http://hl7.org/fhir/ValueSet/tooth"
}
},
{
"id" : "ClaimResponse.addItem.subSite",
"path" : "ClaimResponse.addItem.subSite",
"short" : "Anatomical sub-location",
"definition" : "A region or surface of the bodySite, e.g. limb region or tooth surface(s).",
"requirements" : "Allows insurer to validate specific procedures.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Surface"
}],
"strength" : "example",
"description" : "The code for the tooth surface and surface combinations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/surface"
}
},
{
"id" : "ClaimResponse.addItem.noteNumber",
"path" : "ClaimResponse.addItem.noteNumber",
"short" : "Applicable note numbers",
"definition" : "The numbers associated with notes below which apply to the adjudication of this item.",
"requirements" : "Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "ClaimResponse.addItem.adjudication",
"path" : "ClaimResponse.addItem.adjudication",
"short" : "Added items adjudication",
"definition" : "The adjudication results.",
"min" : 1,
"max" : "*",
"contentReference" : "#ClaimResponse.item.adjudication"
},
{
"id" : "ClaimResponse.addItem.detail",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "AddedItemDetail"
}],
"path" : "ClaimResponse.addItem.detail",
"short" : "Insurer added line details",
"definition" : "The second-tier service adjudications for payor added services.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "ClaimResponse.addItem.detail.productOrService",
"path" : "ClaimResponse.addItem.detail.productOrService",
"short" : "Billing, service, product, or drug code",
"definition" : "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.",
"comment" : "If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.",
"requirements" : "Necessary to state what was provided or done.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceProduct"
}],
"strength" : "example",
"description" : "Allowable service and product codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-uscls"
}
},
{
"id" : "ClaimResponse.addItem.detail.modifier",
"path" : "ClaimResponse.addItem.detail.modifier",
"short" : "Service/Product billing modifiers",
"definition" : "Item typification or modifiers codes to convey additional context for the product or service.",
"comment" : "For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours.",
"requirements" : "To support inclusion of the item for adjudication or to charge an elevated fee.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Modifiers"
}],
"strength" : "example",
"description" : "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-modifiers"
},
"mapping" : [{
"identity" : "rim",
"map" : "24.C, 24.D mods"
}]
},
{
"id" : "ClaimResponse.addItem.detail.quantity",
"path" : "ClaimResponse.addItem.detail.quantity",
"short" : "Count of products or services",
"definition" : "The number of repetitions of a service or product.",
"requirements" : "Required when the product or service code does not convey the quantity provided.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mapping" : [{
"identity" : "rim",
"map" : "24.G"
}]
},
{
"id" : "ClaimResponse.addItem.detail.unitPrice",
"path" : "ClaimResponse.addItem.detail.unitPrice",
"short" : "Fee, charge or cost per item",
"definition" : "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.",
"requirements" : "The amount charged to the patient by the provider for a single unit.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}]
},
{
"id" : "ClaimResponse.addItem.detail.factor",
"path" : "ClaimResponse.addItem.detail.factor",
"short" : "Price scaling factor",
"definition" : "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"comment" : "To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).",
"requirements" : "When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}]
},
{
"id" : "ClaimResponse.addItem.detail.net",
"path" : "ClaimResponse.addItem.detail.net",
"short" : "Total item cost",
"definition" : "The quantity times the unit price for an additional service or product or charge.",
"comment" : "For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.",
"requirements" : "Provides the total amount claimed for the group (if a grouper) or the line item.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}],
"mapping" : [{
"identity" : "rim",
"map" : "24.F"
}]
},
{
"id" : "ClaimResponse.addItem.detail.noteNumber",
"path" : "ClaimResponse.addItem.detail.noteNumber",
"short" : "Applicable note numbers",
"definition" : "The numbers associated with notes below which apply to the adjudication of this item.",
"requirements" : "Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "ClaimResponse.addItem.detail.adjudication",
"path" : "ClaimResponse.addItem.detail.adjudication",
"short" : "Added items detail adjudication",
"definition" : "The adjudication results.",
"min" : 1,
"max" : "*",
"contentReference" : "#ClaimResponse.item.adjudication"
},
{
"id" : "ClaimResponse.addItem.detail.subDetail",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "AddedItemSubDetail"
}],
"path" : "ClaimResponse.addItem.detail.subDetail",
"short" : "Insurer added line items",
"definition" : "The third-tier service adjudications for payor added services.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "ClaimResponse.addItem.detail.subDetail.productOrService",
"path" : "ClaimResponse.addItem.detail.subDetail.productOrService",
"short" : "Billing, service, product, or drug code",
"definition" : "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.",
"comment" : "If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.",
"requirements" : "Necessary to state what was provided or done.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceProduct"
}],
"strength" : "example",
"description" : "Allowable service and product codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-uscls"
}
},
{
"id" : "ClaimResponse.addItem.detail.subDetail.modifier",
"path" : "ClaimResponse.addItem.detail.subDetail.modifier",
"short" : "Service/Product billing modifiers",
"definition" : "Item typification or modifiers codes to convey additional context for the product or service.",
"comment" : "For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours.",
"requirements" : "To support inclusion of the item for adjudication or to charge an elevated fee.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Modifiers"
}],
"strength" : "example",
"description" : "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-modifiers"
},
"mapping" : [{
"identity" : "rim",
"map" : "24.C, 24.D mods"
}]
},
{
"id" : "ClaimResponse.addItem.detail.subDetail.quantity",
"path" : "ClaimResponse.addItem.detail.subDetail.quantity",
"short" : "Count of products or services",
"definition" : "The number of repetitions of a service or product.",
"requirements" : "Required when the product or service code does not convey the quantity provided.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mapping" : [{
"identity" : "rim",
"map" : "24.G"
}]
},
{
"id" : "ClaimResponse.addItem.detail.subDetail.unitPrice",
"path" : "ClaimResponse.addItem.detail.subDetail.unitPrice",
"short" : "Fee, charge or cost per item",
"definition" : "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.",
"requirements" : "The amount charged to the patient by the provider for a single unit.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}]
},
{
"id" : "ClaimResponse.addItem.detail.subDetail.factor",
"path" : "ClaimResponse.addItem.detail.subDetail.factor",
"short" : "Price scaling factor",
"definition" : "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"comment" : "To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).",
"requirements" : "When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}]
},
{
"id" : "ClaimResponse.addItem.detail.subDetail.net",
"path" : "ClaimResponse.addItem.detail.subDetail.net",
"short" : "Total item cost",
"definition" : "The quantity times the unit price for an additional service or product or charge.",
"comment" : "For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.",
"requirements" : "Provides the total amount claimed for the group (if a grouper) or the line item.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}],
"mapping" : [{
"identity" : "rim",
"map" : "24.F"
}]
},
{
"id" : "ClaimResponse.addItem.detail.subDetail.noteNumber",
"path" : "ClaimResponse.addItem.detail.subDetail.noteNumber",
"short" : "Applicable note numbers",
"definition" : "The numbers associated with notes below which apply to the adjudication of this item.",
"requirements" : "Provides a condensed manner for associating human readable descriptive explanations for adjudications on the line item.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "ClaimResponse.addItem.detail.subDetail.adjudication",
"path" : "ClaimResponse.addItem.detail.subDetail.adjudication",
"short" : "Added items detail adjudication",
"definition" : "The adjudication results.",
"min" : 1,
"max" : "*",
"contentReference" : "#ClaimResponse.item.adjudication"
},
{
"id" : "ClaimResponse.adjudication",
"path" : "ClaimResponse.adjudication",
"short" : "Header-level adjudication",
"definition" : "The adjudication results which are presented at the header level rather than at the line-item or add-item levels.",
"requirements" : "Some insurers will receive line-items but provide the adjudication only at a summary or header-level.",
"min" : 0,
"max" : "*",
"contentReference" : "#ClaimResponse.item.adjudication"
},
{
"id" : "ClaimResponse.total",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Total"
}],
"path" : "ClaimResponse.total",
"short" : "Adjudication totals",
"definition" : "Categorized monetary totals for the adjudication.",
"comment" : "Totals for amounts submitted, co-pays, benefits payable etc.",
"requirements" : "To provide the requestor with financial totals by category for the adjudication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "ClaimResponse.total.category",
"path" : "ClaimResponse.total.category",
"short" : "Type of adjudication information",
"definition" : "A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.",
"comment" : "For example codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.",
"requirements" : "Needed to convey the type of total provided.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Adjudication"
}],
"strength" : "example",
"description" : "The adjudication codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/adjudication"
}
},
{
"id" : "ClaimResponse.total.amount",
"path" : "ClaimResponse.total.amount",
"short" : "Financial total for the category",
"definition" : "Monetary total amount associated with the category.",
"requirements" : "Needed to convey the total monetary amount.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Money"
}],
"isSummary" : true
},
{
"id" : "ClaimResponse.payment",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Payment"
}],
"path" : "ClaimResponse.payment",
"short" : "Payment Details",
"definition" : "Payment details for the adjudication of the claim.",
"requirements" : "Needed to convey references to the financial instrument that has been used if payment has been made.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "ClaimResponse.payment.type",
"path" : "ClaimResponse.payment.type",
"short" : "Partial or complete payment",
"definition" : "Whether this represents partial or complete payment of the benefits payable.",
"requirements" : "To advise the requestor when the insurer believes all payments to have been completed.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PaymentType"
}],
"strength" : "example",
"description" : "The type (partial, complete) of the payment.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-paymenttype"
}
},
{
"id" : "ClaimResponse.payment.adjustment",
"path" : "ClaimResponse.payment.adjustment",
"short" : "Payment adjustment for non-claim issues",
"definition" : "Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication.",
"comment" : "Insurers will deduct amounts owing from the provider (adjustment), such as a prior overpayment, from the amount owing to the provider (benefits payable) when payment is made to the provider.",
"requirements" : "To advise the requestor of adjustments applied to the payment.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}]
},
{
"id" : "ClaimResponse.payment.adjustmentReason",
"path" : "ClaimResponse.payment.adjustmentReason",
"short" : "Explanation for the adjustment",
"definition" : "Reason for the payment adjustment.",
"requirements" : "Needed to clarify the monetary adjustment.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PaymentAdjustmentReason"
}],
"strength" : "example",
"description" : "Payment Adjustment reason codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/payment-adjustment-reason"
}
},
{
"id" : "ClaimResponse.payment.date",
"path" : "ClaimResponse.payment.date",
"short" : "Expected date of payment",
"definition" : "Estimated date the payment will be issued or the actual issue date of payment.",
"requirements" : "To advise the payee when payment can be expected.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}]
},
{
"id" : "ClaimResponse.payment.amount",
"path" : "ClaimResponse.payment.amount",
"short" : "Payable amount after adjustment",
"definition" : "Benefits payable less any payment adjustment.",
"requirements" : "Needed to provide the actual payment amount.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Money"
}]
},
{
"id" : "ClaimResponse.payment.identifier",
"path" : "ClaimResponse.payment.identifier",
"short" : "Business identifier for the payment",
"definition" : "Issuer's unique identifier for the payment instrument.",
"comment" : "For example: EFT number or check number.",
"requirements" : "Enable the receiver to reconcile when payment received.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}]
},
{
"id" : "ClaimResponse.fundsReserve",
"path" : "ClaimResponse.fundsReserve",
"short" : "Funds reserved status",
"definition" : "A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.",
"comment" : "Fund would be release by a future claim quoting the preAuthRef of this response. Examples of values include: provider, patient, none.",
"requirements" : "Needed to advise the submitting provider on whether the rquest for reservation of funds has been honored.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FundsReserve"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "example",
"description" : "For whom funds are to be reserved: (Patient, Provider, None).",
"valueSet" : "http://hl7.org/fhir/ValueSet/fundsreserve"
}
},
{
"id" : "ClaimResponse.formCode",
"path" : "ClaimResponse.formCode",
"short" : "Printed form identifier",
"definition" : "A code for the form to be used for printing the content.",
"comment" : "May be needed to identify specific jurisdictional forms.",
"requirements" : "Needed to specify the specific form used for producing output for this response.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Forms"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "example",
"description" : "The forms codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/forms"
}
},
{
"id" : "ClaimResponse.form",
"path" : "ClaimResponse.form",
"short" : "Printed reference or actual form",
"definition" : "The actual form, by reference or inclusion, for printing the content or an EOB.",
"comment" : "Needed to permit insurers to include the actual form.",
"requirements" : "Needed to include the specific form used for producing output for this response.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Attachment"
}]
},
{
"id" : "ClaimResponse.processNote",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Note"
}],
"path" : "ClaimResponse.processNote",
"short" : "Note concerning adjudication",
"definition" : "A note that describes or explains adjudication results in a human readable form.",
"requirements" : "Provides the insurer specific textual explanations associated with the processing.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "ClaimResponse.processNote.number",
"path" : "ClaimResponse.processNote.number",
"short" : "Note instance identifier",
"definition" : "A number to uniquely identify a note entry.",
"requirements" : "Necessary to provide a mechanism to link from adjudications.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "ClaimResponse.processNote.type",
"path" : "ClaimResponse.processNote.type",
"short" : "display | print | printoper",
"definition" : "The business purpose of the note text.",
"requirements" : "To convey the expectation for when the text is used.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NoteType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The presentation types of notes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/note-type|4.0.0"
}
},
{
"id" : "ClaimResponse.processNote.text",
"path" : "ClaimResponse.processNote.text",
"short" : "Note explanatory text",
"definition" : "The explanation or description associated with the processing.",
"requirements" : "Required to provide human readable explanation.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "ClaimResponse.processNote.language",
"path" : "ClaimResponse.processNote.language",
"short" : "Language of the text",
"definition" : "A code to define the language used in the text of the note.",
"comment" : "Only required if the language is different from the resource language.",
"requirements" : "Note text may vary from the resource defined language.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "ClaimResponse.communicationRequest",
"path" : "ClaimResponse.communicationRequest",
"short" : "Request for additional information",
"definition" : "Request for additional supporting or authorizing information.",
"comment" : "For example: professional reports, documents, images, clinical resources, or accident reports.",
"requirements" : "Need to communicate insurer request for additional information required to support the adjudication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CommunicationRequest"]
}]
},
{
"id" : "ClaimResponse.insurance",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Insurance"
}],
"path" : "ClaimResponse.insurance",
"short" : "Patient insurance information",
"definition" : "Financial instruments for reimbursement for the health care products and services specified on the claim.",
"comment" : "All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.",
"requirements" : "At least one insurer is required for a claim to be a claim.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : "Coverage"
}]
},
{
"id" : "ClaimResponse.insurance.sequence",
"path" : "ClaimResponse.insurance.sequence",
"short" : "Insurance instance identifier",
"definition" : "A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.",
"requirements" : "To maintain order of the coverages.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "ClaimResponse.insurance.focal",
"path" : "ClaimResponse.insurance.focal",
"short" : "Coverage to be used for adjudication",
"definition" : "A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.",
"comment" : "A patient may (will) have multiple insurance policies which provide reimbursement for healthcare services and products. For example a person may also be covered by their spouse's policy and both appear in the list (and may be from the same insurer). This flag will be set to true for only one of the listed policies and that policy will be used for adjudicating this claim. Other claims would be created to request adjudication against the other listed policies.",
"requirements" : "To identify which coverage in the list is being used to adjudicate this claim.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "ClaimResponse.insurance.coverage",
"path" : "ClaimResponse.insurance.coverage",
"short" : "Insurance information",
"definition" : "Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.",
"requirements" : "Required to allow the adjudicator to locate the correct policy and history within their information system.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Coverage"]
}]
},
{
"id" : "ClaimResponse.insurance.businessArrangement",
"path" : "ClaimResponse.insurance.businessArrangement",
"short" : "Additional provider contract number",
"definition" : "A business agreement number established between the provider and the insurer for special business processing purposes.",
"requirements" : "Providers may have multiple business arrangements with a given insurer and must supply the specific contract number for adjudication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "ClaimResponse.insurance.claimResponse",
"path" : "ClaimResponse.insurance.claimResponse",
"short" : "Adjudication results",
"definition" : "The result of the adjudication of the line items for the Coverage specified in this insurance.",
"comment" : "Must not be specified when 'focal=true' for this insurance.",
"requirements" : "An insurer need the adjudication results from prior insurers to determine the outstanding balance remaining by item for the items in the curent claim.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ClaimResponse"]
}]
},
{
"id" : "ClaimResponse.error",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Error"
}],
"path" : "ClaimResponse.error",
"short" : "Processing errors",
"definition" : "Errors encountered during the processing of the adjudication.",
"comment" : "If the request contains errors then an error element should be provided and no adjudication related sections (item, addItem, or payment) should be present.",
"requirements" : "Need to communicate processing issues to the requestor.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "ClaimResponse.error.itemSequence",
"path" : "ClaimResponse.error.itemSequence",
"short" : "Item sequence number",
"definition" : "The sequence number of the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.",
"requirements" : "Provides references to the claim items.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "ClaimResponse.error.detailSequence",
"path" : "ClaimResponse.error.detailSequence",
"short" : "Detail sequence number",
"definition" : "The sequence number of the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.",
"requirements" : "Provides references to the claim details within the claim item.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "ClaimResponse.error.subDetailSequence",
"path" : "ClaimResponse.error.subDetailSequence",
"short" : "Subdetail sequence number",
"definition" : "The sequence number of the sub-detail within the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.",
"requirements" : "Provides references to the claim sub-details within the claim detail.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "ClaimResponse.error.code",
"path" : "ClaimResponse.error.code",
"short" : "Error code detailing processing issues",
"definition" : "An error code, from a specified code system, which details why the claim could not be adjudicated.",
"requirements" : "Required to convey processing errors.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdjudicationError"
}],
"strength" : "example",
"description" : "The adjudication error codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/adjudication-error"
}
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/ClinicalImpression",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "ClinicalImpression",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints ClinicalImpression TU DomainResource A clinical assessment performed when planning treatments and management strategies for a patient
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension \r\n identifier Σ 0..* Identifier Business identifier
\r\n status ?!Σ 1..1 code draft | completed | entered-in-error
Clinical Impression Status (Required) \r\n statusReason 0..1 CodeableConcept Reason for current status \r\n code Σ 0..1 CodeableConcept Kind of assessment performed \r\n description Σ 0..1 string Why/how the assessment was performed \r\n subject Σ 1..1 Reference(Patient | Group) Patient or group assessed \r\n encounter Σ 0..1 Reference(Encounter) Encounter created as part of \r\n effective[x] Σ 0..1 Time of assessment \r\n effectiveDateTime dateTime \r\n effectivePeriod Period \r\n date Σ 0..1 dateTime When the assessment was documented \r\n assessor Σ 0..1 Reference(Practitioner | PractitionerRole) The clinician performing the assessment \r\n previous 0..1 Reference(ClinicalImpression) Reference to last assessment \r\n problem Σ 0..* Reference(Condition | AllergyIntolerance) Relevant impressions of patient state
\r\n investigation 0..* BackboneElement One or more sets of investigations (signs, symptoms, etc.)
\r\n code 1..1 CodeableConcept A name/code for the set
Investigation Type (Example) \r\n item 0..* Reference(Observation | QuestionnaireResponse | FamilyMemberHistory | DiagnosticReport | RiskAssessment | ImagingStudy | Media) Record of a specific investigation
\r\n protocol 0..* uri Clinical Protocol followed
\r\n summary 0..1 string Summary of the assessment \r\n finding 0..* BackboneElement Possible or likely findings and diagnoses
\r\n itemCodeableConcept 0..1 CodeableConcept What was found
Condition/Problem/Diagnosis Codes (Example) \r\n itemReference 0..1 Reference(Condition | Observation | Media) What was found \r\n basis 0..1 string Which investigations support finding \r\n prognosisCodeableConcept 0..* CodeableConcept Estimate of likely outcome
Clinical Impression Prognosis (Example)
\r\n prognosisReference 0..* Reference(RiskAssessment) RiskAssessment expressing likely outcome
\r\n supportingInfo 0..* Reference(Any) Information supporting the clinical impression
\r\n note 0..* Annotation Comments made about the ClinicalImpression
\r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Summary"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pc"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/ClinicalImpression",
"version" : "4.0.0",
"name" : "ClinicalImpression",
"status" : "draft",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (Patient Care)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}]
}],
"description" : "A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called \"ClinicalImpression\" rather than \"ClinicalAssessment\" to avoid confusion with the recording of assessment tools such as Apgar score.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "ClinicalImpression",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "ClinicalImpression",
"path" : "ClinicalImpression",
"short" : "A clinical assessment performed when planning treatments and management strategies for a patient",
"definition" : "A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called \"ClinicalImpression\" rather than \"ClinicalAssessment\" to avoid confusion with the recording of assessment tools such as Apgar score.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalImpression",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "v2",
"map" : "Partial mapping for problem evaluation"
}]
},
{
"id" : "ClinicalImpression.id",
"path" : "ClinicalImpression.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ClinicalImpression.meta",
"path" : "ClinicalImpression.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ClinicalImpression.implicitRules",
"path" : "ClinicalImpression.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "ClinicalImpression.language",
"path" : "ClinicalImpression.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "ClinicalImpression.text",
"path" : "ClinicalImpression.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "ClinicalImpression.contained",
"path" : "ClinicalImpression.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ClinicalImpression.extension",
"path" : "ClinicalImpression.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ClinicalImpression.modifierExtension",
"path" : "ClinicalImpression.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ClinicalImpression.identifier",
"path" : "ClinicalImpression.identifier",
"short" : "Business identifier",
"definition" : "Business identifiers assigned to this clinical impression by the performer or other systems which remain constant as the resource is updated and propagates from server to server.",
"comment" : "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"requirements" : "Allows identification of the clinical impression as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalImpression.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "PID-3"
}]
},
{
"id" : "ClinicalImpression.status",
"path" : "ClinicalImpression.status",
"short" : "draft | completed | entered-in-error",
"definition" : "Identifies the workflow status of the assessment.",
"comment" : "This element is labeled as a modifier because the status contains the code entered-in-error that marks the clinical impression as not currently valid.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalImpression.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClinicalImpressionStatus"
}],
"strength" : "required",
"description" : "The workflow state of a clinical impression.",
"valueSet" : "http://hl7.org/fhir/ValueSet/clinicalimpression-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "PRB-14"
}]
},
{
"id" : "ClinicalImpression.statusReason",
"path" : "ClinicalImpression.statusReason",
"short" : "Reason for current status",
"definition" : "Captures the reason for the current state of the ClinicalImpression.",
"comment" : "This is generally only used for \"exception\" statuses such as \"not-done\", \"suspended\" or \"cancelled\".\n\n[distinct reason codes for different statuses can be enforced using invariants if they are universal bindings].",
"alias" : ["Suspended Reason",
"Cancelled Reason"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalImpression.statusReason",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClinicalImpressionStatusReason"
}],
"strength" : "example",
"description" : "Codes identifying the reason for the current state of a clinical impression."
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.statusReason"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde"
}]
},
{
"id" : "ClinicalImpression.code",
"path" : "ClinicalImpression.code",
"short" : "Kind of assessment performed",
"definition" : "Categorizes the type of clinical assessment performed.",
"comment" : "This is present as a place-holder only and may be removed based on feedback/work group opinion.",
"alias" : ["type"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalImpression.code",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClinicalImpressionCode"
}],
"strength" : "example",
"description" : "Identifies categories of clinical impressions. This is a place-holder only. It may be removed."
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
}]
},
{
"id" : "ClinicalImpression.description",
"path" : "ClinicalImpression.description",
"short" : "Why/how the assessment was performed",
"definition" : "A summary of the context and/or cause of the assessment - why / where it was performed, and what patient events/status prompted it.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalImpression.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ClinicalImpression.subject",
"path" : "ClinicalImpression.subject",
"short" : "Patient or group assessed",
"definition" : "The patient or group of individuals assessed as part of this record.",
"requirements" : "Group is typically for veterinary and/or public health purposes.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalImpression.subject",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PID-3"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "ClinicalImpression.encounter",
"path" : "ClinicalImpression.encounter",
"short" : "Encounter created as part of",
"definition" : "The Encounter during which this ClinicalImpression was created or to which the creation of this record is tightly associated.",
"comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalImpression.encounter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.context"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
}]
},
{
"id" : "ClinicalImpression.effective[x]",
"path" : "ClinicalImpression.effective[x]",
"short" : "Time of assessment",
"definition" : "The point in time or period over which the subject was assessed.",
"comment" : "This SHOULD be accurate to at least the minute, though some assessments only have a known date.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalImpression.effective[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "v2",
"map" : "PRB-2"
}]
},
{
"id" : "ClinicalImpression.date",
"path" : "ClinicalImpression.date",
"short" : "When the assessment was documented",
"definition" : "Indicates when the documentation of the assessment was complete.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalImpression.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "ClinicalImpression.assessor",
"path" : "ClinicalImpression.assessor",
"short" : "The clinician performing the assessment",
"definition" : "The clinician performing the assessment.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalImpression.assessor",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "v2",
"map" : "ROL-4"
}]
},
{
"id" : "ClinicalImpression.previous",
"path" : "ClinicalImpression.previous",
"short" : "Reference to last assessment",
"definition" : "A reference to the last assessment that was conducted on this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient's conditions changes.",
"comment" : "It is always likely that multiple previous assessments exist for a patient. The point of quoting a previous assessment is that this assessment is relative to it (see resolved).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalImpression.previous",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ClinicalImpression"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClinicalImpression.problem",
"path" : "ClinicalImpression.problem",
"short" : "Relevant impressions of patient state",
"definition" : "A list of the relevant problems/conditions for a patient.",
"comment" : "e.g. The patient is a pregnant, has congestive heart failure, has an Adenocarcinoma, and is allergic to penicillin.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalImpression.problem",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/AllergyIntolerance"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "v2",
"map" : "PRB-3 / IAM-7"
}]
},
{
"id" : "ClinicalImpression.investigation",
"path" : "ClinicalImpression.investigation",
"short" : "One or more sets of investigations (signs, symptoms, etc.)",
"definition" : "One or more sets of investigations (signs, symptoms, etc.). The actual grouping of investigations varies greatly depending on the type and context of the assessment. These investigations may include data generated during the assessment process, or data previously generated and recorded that is pertinent to the outcomes.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalImpression.investigation",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClinicalImpression.investigation.id",
"path" : "ClinicalImpression.investigation.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClinicalImpression.investigation.extension",
"path" : "ClinicalImpression.investigation.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClinicalImpression.investigation.modifierExtension",
"path" : "ClinicalImpression.investigation.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ClinicalImpression.investigation.code",
"path" : "ClinicalImpression.investigation.code",
"short" : "A name/code for the set",
"definition" : "A name/code for the group (\"set\") of investigations. Typically, this will be something like \"signs\", \"symptoms\", \"clinical\", \"diagnostic\", but the list is not constrained, and others such groups such as (exposure|family|travel|nutritional) history may be used.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalImpression.investigation.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "InvestigationGroupType"
}],
"strength" : "example",
"description" : "A name/code for a set of investigations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/investigation-sets"
}
},
{
"id" : "ClinicalImpression.investigation.item",
"path" : "ClinicalImpression.investigation.item",
"short" : "Record of a specific investigation",
"definition" : "A record of a specific investigation that was undertaken.",
"comment" : "Most investigations are observations of one kind or another but some other specific types of data collection resources can also be used.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalImpression.investigation.item",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse",
"http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/RiskAssessment",
"http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"http://hl7.org/fhir/StructureDefinition/Media"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OBX-21"
}]
},
{
"id" : "ClinicalImpression.protocol",
"path" : "ClinicalImpression.protocol",
"short" : "Clinical Protocol followed",
"definition" : "Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalImpression.protocol",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClinicalImpression.summary",
"path" : "ClinicalImpression.summary",
"short" : "Summary of the assessment",
"definition" : "A text summary of the investigations and the diagnosis.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalImpression.summary",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OBX"
}]
},
{
"id" : "ClinicalImpression.finding",
"path" : "ClinicalImpression.finding",
"short" : "Possible or likely findings and diagnoses",
"definition" : "Specific findings or diagnoses that were considered likely or relevant to ongoing treatment.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalImpression.finding",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClinicalImpression.finding.id",
"path" : "ClinicalImpression.finding.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClinicalImpression.finding.extension",
"path" : "ClinicalImpression.finding.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ClinicalImpression.finding.modifierExtension",
"path" : "ClinicalImpression.finding.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ClinicalImpression.finding.itemCodeableConcept",
"path" : "ClinicalImpression.finding.itemCodeableConcept",
"short" : "What was found",
"definition" : "Specific text or code for finding or diagnosis, which may include ruled-out or resolved conditions.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalImpression.finding.itemCodeableConcept",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConditionKind"
}],
"strength" : "example",
"description" : "Identification of the Condition or diagnosis.",
"valueSet" : "http://hl7.org/fhir/ValueSet/condition-code"
},
"mapping" : [{
"identity" : "v2",
"map" : "OBX"
}]
},
{
"id" : "ClinicalImpression.finding.itemReference",
"path" : "ClinicalImpression.finding.itemReference",
"short" : "What was found",
"definition" : "Specific reference for finding or diagnosis, which may include ruled-out or resolved conditions.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalImpression.finding.itemReference",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/Media"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OBX"
}]
},
{
"id" : "ClinicalImpression.finding.basis",
"path" : "ClinicalImpression.finding.basis",
"short" : "Which investigations support finding",
"definition" : "Which investigations support finding or diagnosis.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalImpression.finding.basis",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClinicalImpression.prognosisCodeableConcept",
"path" : "ClinicalImpression.prognosisCodeableConcept",
"short" : "Estimate of likely outcome",
"definition" : "Estimate of likely outcome.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalImpression.prognosisCodeableConcept",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClinicalImpressionPrognosis"
}],
"strength" : "example",
"description" : "Prognosis or outlook findings.",
"valueSet" : "http://hl7.org/fhir/ValueSet/clinicalimpression-prognosis"
},
"mapping" : [{
"identity" : "v2",
"map" : "PRB-22"
}]
},
{
"id" : "ClinicalImpression.prognosisReference",
"path" : "ClinicalImpression.prognosisReference",
"short" : "RiskAssessment expressing likely outcome",
"definition" : "RiskAssessment expressing likely outcome.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalImpression.prognosisReference",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/RiskAssessment"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClinicalImpression.supportingInfo",
"path" : "ClinicalImpression.supportingInfo",
"short" : "Information supporting the clinical impression",
"definition" : "Information supporting the clinical impression.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalImpression.supportingInfo",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ClinicalImpression.note",
"path" : "ClinicalImpression.note",
"short" : "Comments made about the ClinicalImpression",
"definition" : "Commentary about the impression, typically recorded after the impression itself was made, though supplemental notes by the original author could also appear.",
"comment" : "Don't use this element for content that should more properly appear as one of the specific elements of the impression.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalImpression.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
}]
}]
},
"differential" : {
"element" : [{
"id" : "ClinicalImpression",
"path" : "ClinicalImpression",
"short" : "A clinical assessment performed when planning treatments and management strategies for a patient",
"definition" : "A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called \"ClinicalImpression\" rather than \"ClinicalAssessment\" to avoid confusion with the recording of assessment tools such as Apgar score.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "v2",
"map" : "Partial mapping for problem evaluation"
}]
},
{
"id" : "ClinicalImpression.identifier",
"path" : "ClinicalImpression.identifier",
"short" : "Business identifier",
"definition" : "Business identifiers assigned to this clinical impression by the performer or other systems which remain constant as the resource is updated and propagates from server to server.",
"comment" : "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"requirements" : "Allows identification of the clinical impression as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "PID-3"
}]
},
{
"id" : "ClinicalImpression.status",
"path" : "ClinicalImpression.status",
"short" : "draft | completed | entered-in-error",
"definition" : "Identifies the workflow status of the assessment.",
"comment" : "This element is labeled as a modifier because the status contains the code entered-in-error that marks the clinical impression as not currently valid.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClinicalImpressionStatus"
}],
"strength" : "required",
"description" : "The workflow state of a clinical impression.",
"valueSet" : "http://hl7.org/fhir/ValueSet/clinicalimpression-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "PRB-14"
}]
},
{
"id" : "ClinicalImpression.statusReason",
"path" : "ClinicalImpression.statusReason",
"short" : "Reason for current status",
"definition" : "Captures the reason for the current state of the ClinicalImpression.",
"comment" : "This is generally only used for \"exception\" statuses such as \"not-done\", \"suspended\" or \"cancelled\".\n\n[distinct reason codes for different statuses can be enforced using invariants if they are universal bindings].",
"alias" : ["Suspended Reason",
"Cancelled Reason"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClinicalImpressionStatusReason"
}],
"strength" : "example",
"description" : "Codes identifying the reason for the current state of a clinical impression."
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.statusReason"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde"
}]
},
{
"id" : "ClinicalImpression.code",
"path" : "ClinicalImpression.code",
"short" : "Kind of assessment performed",
"definition" : "Categorizes the type of clinical assessment performed.",
"comment" : "This is present as a place-holder only and may be removed based on feedback/work group opinion.",
"alias" : ["type"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClinicalImpressionCode"
}],
"strength" : "example",
"description" : "Identifies categories of clinical impressions. This is a place-holder only. It may be removed."
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
}]
},
{
"id" : "ClinicalImpression.description",
"path" : "ClinicalImpression.description",
"short" : "Why/how the assessment was performed",
"definition" : "A summary of the context and/or cause of the assessment - why / where it was performed, and what patient events/status prompted it.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "ClinicalImpression.subject",
"path" : "ClinicalImpression.subject",
"short" : "Patient or group assessed",
"definition" : "The patient or group of individuals assessed as part of this record.",
"requirements" : "Group is typically for veterinary and/or public health purposes.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PID-3"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "ClinicalImpression.encounter",
"path" : "ClinicalImpression.encounter",
"short" : "Encounter created as part of",
"definition" : "The Encounter during which this ClinicalImpression was created or to which the creation of this record is tightly associated.",
"comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.context"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
}]
},
{
"id" : "ClinicalImpression.effective[x]",
"path" : "ClinicalImpression.effective[x]",
"short" : "Time of assessment",
"definition" : "The point in time or period over which the subject was assessed.",
"comment" : "This SHOULD be accurate to at least the minute, though some assessments only have a known date.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "v2",
"map" : "PRB-2"
}]
},
{
"id" : "ClinicalImpression.date",
"path" : "ClinicalImpression.date",
"short" : "When the assessment was documented",
"definition" : "Indicates when the documentation of the assessment was complete.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "ClinicalImpression.assessor",
"path" : "ClinicalImpression.assessor",
"short" : "The clinician performing the assessment",
"definition" : "The clinician performing the assessment.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "v2",
"map" : "ROL-4"
}]
},
{
"id" : "ClinicalImpression.previous",
"path" : "ClinicalImpression.previous",
"short" : "Reference to last assessment",
"definition" : "A reference to the last assessment that was conducted on this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient's conditions changes.",
"comment" : "It is always likely that multiple previous assessments exist for a patient. The point of quoting a previous assessment is that this assessment is relative to it (see resolved).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ClinicalImpression"]
}]
},
{
"id" : "ClinicalImpression.problem",
"path" : "ClinicalImpression.problem",
"short" : "Relevant impressions of patient state",
"definition" : "A list of the relevant problems/conditions for a patient.",
"comment" : "e.g. The patient is a pregnant, has congestive heart failure, has an Adenocarcinoma, and is allergic to penicillin.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/AllergyIntolerance"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "v2",
"map" : "PRB-3 / IAM-7"
}]
},
{
"id" : "ClinicalImpression.investigation",
"path" : "ClinicalImpression.investigation",
"short" : "One or more sets of investigations (signs, symptoms, etc.)",
"definition" : "One or more sets of investigations (signs, symptoms, etc.). The actual grouping of investigations varies greatly depending on the type and context of the assessment. These investigations may include data generated during the assessment process, or data previously generated and recorded that is pertinent to the outcomes.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "ClinicalImpression.investigation.code",
"path" : "ClinicalImpression.investigation.code",
"short" : "A name/code for the set",
"definition" : "A name/code for the group (\"set\") of investigations. Typically, this will be something like \"signs\", \"symptoms\", \"clinical\", \"diagnostic\", but the list is not constrained, and others such groups such as (exposure|family|travel|nutritional) history may be used.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "InvestigationGroupType"
}],
"strength" : "example",
"description" : "A name/code for a set of investigations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/investigation-sets"
}
},
{
"id" : "ClinicalImpression.investigation.item",
"path" : "ClinicalImpression.investigation.item",
"short" : "Record of a specific investigation",
"definition" : "A record of a specific investigation that was undertaken.",
"comment" : "Most investigations are observations of one kind or another but some other specific types of data collection resources can also be used.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse",
"http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/RiskAssessment",
"http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"http://hl7.org/fhir/StructureDefinition/Media"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "OBX-21"
}]
},
{
"id" : "ClinicalImpression.protocol",
"path" : "ClinicalImpression.protocol",
"short" : "Clinical Protocol followed",
"definition" : "Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "uri"
}]
},
{
"id" : "ClinicalImpression.summary",
"path" : "ClinicalImpression.summary",
"short" : "Summary of the assessment",
"definition" : "A text summary of the investigations and the diagnosis.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OBX"
}]
},
{
"id" : "ClinicalImpression.finding",
"path" : "ClinicalImpression.finding",
"short" : "Possible or likely findings and diagnoses",
"definition" : "Specific findings or diagnoses that were considered likely or relevant to ongoing treatment.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "ClinicalImpression.finding.itemCodeableConcept",
"path" : "ClinicalImpression.finding.itemCodeableConcept",
"short" : "What was found",
"definition" : "Specific text or code for finding or diagnosis, which may include ruled-out or resolved conditions.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConditionKind"
}],
"strength" : "example",
"description" : "Identification of the Condition or diagnosis.",
"valueSet" : "http://hl7.org/fhir/ValueSet/condition-code"
},
"mapping" : [{
"identity" : "v2",
"map" : "OBX"
}]
},
{
"id" : "ClinicalImpression.finding.itemReference",
"path" : "ClinicalImpression.finding.itemReference",
"short" : "What was found",
"definition" : "Specific reference for finding or diagnosis, which may include ruled-out or resolved conditions.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/Media"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "OBX"
}]
},
{
"id" : "ClinicalImpression.finding.basis",
"path" : "ClinicalImpression.finding.basis",
"short" : "Which investigations support finding",
"definition" : "Which investigations support finding or diagnosis.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "ClinicalImpression.prognosisCodeableConcept",
"path" : "ClinicalImpression.prognosisCodeableConcept",
"short" : "Estimate of likely outcome",
"definition" : "Estimate of likely outcome.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClinicalImpressionPrognosis"
}],
"strength" : "example",
"description" : "Prognosis or outlook findings.",
"valueSet" : "http://hl7.org/fhir/ValueSet/clinicalimpression-prognosis"
},
"mapping" : [{
"identity" : "v2",
"map" : "PRB-22"
}]
},
{
"id" : "ClinicalImpression.prognosisReference",
"path" : "ClinicalImpression.prognosisReference",
"short" : "RiskAssessment expressing likely outcome",
"definition" : "RiskAssessment expressing likely outcome.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/RiskAssessment"]
}]
},
{
"id" : "ClinicalImpression.supportingInfo",
"path" : "ClinicalImpression.supportingInfo",
"short" : "Information supporting the clinical impression",
"definition" : "Information supporting the clinical impression.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}]
},
{
"id" : "ClinicalImpression.note",
"path" : "ClinicalImpression.note",
"short" : "Comments made about the ClinicalImpression",
"definition" : "Commentary about the impression, typically recorded after the impression itself was made, though supplemental notes by the original author could also appear.",
"comment" : "Don't use this element for content that should more properly appear as one of the specific elements of the impression.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/CodeSystem",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "CodeSystem",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints CodeSystem IN DomainResource Declares the existence of and describes a code system or code system supplement
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
+ Rule: Within a code system definition, all the codes SHALL be unique
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension \r\n url Σ 0..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) \r\n identifier Σ 0..* Identifier Additional identifier for the code system (business identifier)
\r\n version Σ 0..1 string Business version of the code system (Coding.version) \r\n name ΣI 0..1 string Name for this code system (computer friendly) \r\n title Σ 0..1 string Name for this code system (human friendly) \r\n status ?!Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required) \r\n experimental Σ 0..1 boolean For testing purposes, not real usage \r\n date Σ 0..1 dateTime Date last changed \r\n publisher Σ 0..1 string Name of the publisher (organization or individual) \r\n contact Σ 0..* ContactDetail Contact details for the publisher
\r\n description 0..1 markdown Natural language description of the code system \r\n useContext ΣTU 0..* UsageContext The context that the content is intended to support
\r\n jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for code system (if applicable)
Jurisdiction (Extensible)
\r\n purpose 0..1 markdown Why this code system is defined \r\n copyright 0..1 markdown Use and/or publishing restrictions \r\n caseSensitive Σ 0..1 boolean If code comparison is case sensitive \r\n valueSet Σ 0..1 canonical(ValueSet) Canonical reference to the value set with entire code system \r\n hierarchyMeaning Σ 0..1 code grouped-by | is-a | part-of | classified-with
CodeSystemHierarchyMeaning (Required) \r\n compositional Σ 0..1 boolean If code system defines a compositional grammar \r\n versionNeeded Σ 0..1 boolean If definitions are not stable \r\n content Σ 1..1 code not-present | example | fragment | complete | supplement
CodeSystemContentMode (Required) \r\n supplements Σ 0..1 canonical(CodeSystem) Canonical URL of Code System this adds designations and properties to \r\n count Σ 0..1 unsignedInt Total concepts in the code system \r\n filter Σ 0..* BackboneElement Filter that can be used in a value set
\r\n code Σ 1..1 code Code that identifies the filter \r\n description Σ 0..1 string How or why the filter is used \r\n operator Σ 1..* code Operators that can be used with filter
FilterOperator (Required)
\r\n value Σ 1..1 string What to use for the value \r\n property Σ 0..* BackboneElement Additional information supplied about each concept
\r\n code Σ 1..1 code Identifies the property on the concepts, and when referred to in operations \r\n uri Σ 0..1 uri Formal identifier for the property \r\n description Σ 0..1 string Why the property is defined, and/or what it conveys \r\n type Σ 1..1 code code | Coding | string | integer | boolean | dateTime | decimal
PropertyType (Required) \r\n concept 0..* BackboneElement Concepts in the code system
\r\n code 1..1 code Code that identifies concept \r\n display 0..1 string Text to display to the user \r\n definition 0..1 string Formal definition \r\n designation 0..* BackboneElement Additional representations for the concept
\r\n language 0..1 code Human language of the designation
Common Languages (Preferred but limited to AllLanguages) \r\n use 0..1 Coding Details how this designation would be used
Designation Use (Extensible) \r\n value 1..1 string The text value for this designation \r\n property 0..* BackboneElement Property value for the concept
\r\n code 1..1 code Reference to CodeSystem.property.code \r\n value[x] 1..1 Value of the property for this concept \r\n valueCode code \r\n valueCoding Coding \r\n valueString string \r\n valueInteger integer \r\n valueBoolean boolean \r\n valueDateTime dateTime \r\n valueDecimal decimal \r\n concept 0..* see concept Child Concepts (is-a/contains/categorizes)
\r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Terminology"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "vocab"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/CodeSystem",
"version" : "4.0.0",
"name" : "CodeSystem",
"status" : "active",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (Vocabulary)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/Vocab/index.cfm"
}]
}],
"description" : "The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "objimpl",
"uri" : "http://hl7.org/fhir/object-implementation",
"name" : "Object Implementation Information"
}],
"kind" : "resource",
"abstract" : false,
"type" : "CodeSystem",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString" : "MetadataResource"
}]
},
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "CodeSystem",
"path" : "CodeSystem",
"short" : "Declares the existence of and describes a code system or code system supplement",
"definition" : "The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CodeSystem",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
},
{
"key" : "csd-1",
"severity" : "error",
"human" : "Within a code system definition, all the codes SHALL be unique",
"expression" : "concept.code.combine($this.descendants().concept.code).isDistinct()",
"xpath" : "count(distinct-values(descendant::f:concept/f:code/@value))=count(descendant::f:concept)"
},
{
"key" : "csd-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CodeSystem.id",
"path" : "CodeSystem.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CodeSystem.meta",
"path" : "CodeSystem.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CodeSystem.implicitRules",
"path" : "CodeSystem.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "CodeSystem.language",
"path" : "CodeSystem.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "CodeSystem.text",
"path" : "CodeSystem.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "CodeSystem.contained",
"path" : "CodeSystem.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CodeSystem.extension",
"path" : "CodeSystem.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CodeSystem.modifierExtension",
"path" : "CodeSystem.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CodeSystem.url",
"path" : "CodeSystem.url",
"short" : "Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)",
"definition" : "An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this code system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the code system is stored on different servers. This is used in [Coding](datatypes.html#Coding).system.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the code system to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeSystem.url",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "CodeSystem.identifier",
"path" : "CodeSystem.identifier",
"short" : "Additional identifier for the code system (business identifier)",
"definition" : "A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this code system outside of FHIR, where it is not possible to use the logical URI. Note that HL7 defines at least three identifiers for many of its code systems - the FHIR canonical URL, the OID and the V2 Table 0396 mnemonic code.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CodeSystem.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "CodeSystem.version",
"path" : "CodeSystem.version",
"short" : "Business version of the code system (Coding.version)",
"definition" : "The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in [Coding](datatypes.html#Coding).version.",
"comment" : "There may be different code system instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the code system with the format [url]|[version].",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeSystem.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "CodeSystem.name",
"path" : "CodeSystem.name",
"short" : "Name for this code system (computer friendly)",
"definition" : "A natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeSystem.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CodeSystem.title",
"path" : "CodeSystem.title",
"short" : "Name for this code system (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the code system.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeSystem.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "CodeSystem.status",
"path" : "CodeSystem.status",
"short" : "draft | active | retired | unknown",
"definition" : "The date (and optionally time) when the code system resource was created or revised.",
"comment" : "Allows filtering of code systems that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CodeSystem.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "CodeSystem.experimental",
"path" : "CodeSystem.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of code systems that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level code system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeSystem.experimental",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "CodeSystem.date",
"path" : "CodeSystem.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the code system was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the code system changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the code system. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeSystem.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "CodeSystem.publisher",
"path" : "CodeSystem.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the code system.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the code system is the organization or individual primarily responsible for the maintenance and upkeep of the code system. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the code system. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the code system. May also allow for contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeSystem.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "CodeSystem.contact",
"path" : "CodeSystem.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CodeSystem.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "CodeSystem.description",
"path" : "CodeSystem.description",
"short" : "Natural language description of the code system",
"definition" : "A free text natural language description of the code system from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the code system was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the code system as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the code system is presumed to be the predominant language in the place the code system was created).",
"alias" : ["Scope",
"Purpose"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeSystem.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CodeSystem.useContext",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CodeSystem.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate code system instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CodeSystem.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "CodeSystem.jurisdiction",
"path" : "CodeSystem.jurisdiction",
"short" : "Intended jurisdiction for code system (if applicable)",
"definition" : "A legal or geographic region in which the code system is intended to be used.",
"comment" : "It may be possible for the code system to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CodeSystem.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "CodeSystem.purpose",
"path" : "CodeSystem.purpose",
"short" : "Why this code system is defined",
"definition" : "Explanation of why this code system is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the code system. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this code system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeSystem.purpose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "CodeSystem.copyright",
"path" : "CodeSystem.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.",
"comment" : "... Sometimes, the copyright differs between the code system and the codes that are included. The copyright statement should clearly differentiate between these when required.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the code system and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeSystem.copyright",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "CodeSystem.caseSensitive",
"path" : "CodeSystem.caseSensitive",
"short" : "If code comparison is case sensitive",
"definition" : "If code comparison is case sensitive when codes within this system are compared to each other.",
"comment" : "If this value is missing, then it is not specified whether a code system is case sensitive or not. When the rule is not known, Postel's law should be followed: produce codes with the correct case, and accept codes in any case. This element is primarily provided to support validation software.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeSystem.caseSensitive",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CodeSystem.valueSet",
"path" : "CodeSystem.valueSet",
"short" : "Canonical reference to the value set with entire code system",
"definition" : "Canonical reference to the value set that contains the entire code system.",
"comment" : "The definition of the value set SHALL include all codes from this code system and only codes from this code system, and it SHALL be immutable.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeSystem.valueSet",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CodeSystem.hierarchyMeaning",
"path" : "CodeSystem.hierarchyMeaning",
"short" : "grouped-by | is-a | part-of | classified-with",
"definition" : "The meaning of the hierarchy of concepts as represented in this resource.",
"comment" : "Note that other representations might have a different hierarchy or none at all, and represent the information using properties.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeSystem.hierarchyMeaning",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CodeSystemHierarchyMeaning"
}],
"strength" : "required",
"description" : "The meaning of the hierarchy of concepts in a code system.",
"valueSet" : "http://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning|4.0.0"
}
},
{
"id" : "CodeSystem.compositional",
"path" : "CodeSystem.compositional",
"short" : "If code system defines a compositional grammar",
"definition" : "The code system defines a compositional (post-coordination) grammar.",
"comment" : "Note that the code system resource does not define what the compositional grammar is, only whether or not there is one.",
"alias" : ["grammar"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeSystem.compositional",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CodeSystem.versionNeeded",
"path" : "CodeSystem.versionNeeded",
"short" : "If definitions are not stable",
"definition" : "This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system.",
"comment" : "Best practice is that code systems do not redefine concepts, or that if concepts are redefined, a new code system definition is created. But this is not always possible, so some code systems may be defined as 'versionNeeded'.\n\nMost code systems occasionally refine the displays defined for concepts between versions. Contexts in which the concept display values are validated may require that the version be specified for some code systems irrespective of the value of this property.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeSystem.versionNeeded",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CodeSystem.content",
"path" : "CodeSystem.content",
"short" : "not-present | example | fragment | complete | supplement",
"definition" : "The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CodeSystem.content",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CodeSystemContentMode"
}],
"strength" : "required",
"description" : "The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.",
"valueSet" : "http://hl7.org/fhir/ValueSet/codesystem-content-mode|4.0.0"
}
},
{
"id" : "CodeSystem.supplements",
"path" : "CodeSystem.supplements",
"short" : "Canonical URL of Code System this adds designations and properties to",
"definition" : "The canonical URL of the code system that this code system supplement is adding designations and properties to.",
"comment" : "The most common use of a code system supplement is to add additional language support.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeSystem.supplements",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CodeSystem"]
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CodeSystem.count",
"path" : "CodeSystem.count",
"short" : "Total concepts in the code system",
"definition" : "The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward.",
"comment" : "The count of concepts defined in this resource cannot be more than this value but may be less for several reasons - see the content element.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeSystem.count",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "unsignedInt"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CodeSystem.filter",
"path" : "CodeSystem.filter",
"short" : "Filter that can be used in a value set",
"definition" : "A filter that can be used in a value set compose statement when selecting concepts using a filter.",
"comment" : "Note that filters defined in code systems usually require custom code on the part of any terminology engine that will make them available for use in value set filters. For this reason, they are generally only seen in high value published terminologies.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CodeSystem.filter",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CodeSystem.filter.id",
"path" : "CodeSystem.filter.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CodeSystem.filter.extension",
"path" : "CodeSystem.filter.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CodeSystem.filter.modifierExtension",
"path" : "CodeSystem.filter.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CodeSystem.filter.code",
"path" : "CodeSystem.filter.code",
"short" : "Code that identifies the filter",
"definition" : "The code that identifies this filter when it is used as a filter in [ValueSet](valueset.html#).compose.include.filter.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CodeSystem.filter.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CodeSystem.filter.description",
"path" : "CodeSystem.filter.description",
"short" : "How or why the filter is used",
"definition" : "A description of how or why the filter is used.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeSystem.filter.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CodeSystem.filter.operator",
"path" : "CodeSystem.filter.operator",
"short" : "Operators that can be used with filter",
"definition" : "A list of operators that can be used with the filter.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "CodeSystem.filter.operator",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FilterOperator"
}],
"strength" : "required",
"description" : "The kind of operation to perform as a part of a property based filter.",
"valueSet" : "http://hl7.org/fhir/ValueSet/filter-operator|4.0.0"
}
},
{
"id" : "CodeSystem.filter.value",
"path" : "CodeSystem.filter.value",
"short" : "What to use for the value",
"definition" : "A description of what the value for the filter should be.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CodeSystem.filter.value",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CodeSystem.property",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Property"
}],
"path" : "CodeSystem.property",
"short" : "Additional information supplied about each concept",
"definition" : "A property defines an additional slot through which additional information can be provided about a concept.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CodeSystem.property",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CodeSystem.property.id",
"path" : "CodeSystem.property.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CodeSystem.property.extension",
"path" : "CodeSystem.property.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CodeSystem.property.modifierExtension",
"path" : "CodeSystem.property.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CodeSystem.property.code",
"path" : "CodeSystem.property.code",
"short" : "Identifies the property on the concepts, and when referred to in operations",
"definition" : "A code that is used to identify the property. The code is used internally (in CodeSystem.concept.property.code) and also externally, such as in property filters.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CodeSystem.property.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CodeSystem.property.uri",
"path" : "CodeSystem.property.uri",
"short" : "Formal identifier for the property",
"definition" : "Reference to the formal meaning of the property. One possible source of meaning is the [Concept Properties](codesystem-concept-properties.html) code system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeSystem.property.uri",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CodeSystem.property.description",
"path" : "CodeSystem.property.description",
"short" : "Why the property is defined, and/or what it conveys",
"definition" : "A description of the property- why it is defined, and how its value might be used.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeSystem.property.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CodeSystem.property.type",
"path" : "CodeSystem.property.type",
"short" : "code | Coding | string | integer | boolean | dateTime | decimal",
"definition" : "The type of the property value. Properties of type \"code\" contain a code defined by the code system (e.g. a reference to another defined concept).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CodeSystem.property.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PropertyType"
}],
"strength" : "required",
"description" : "The type of a property value.",
"valueSet" : "http://hl7.org/fhir/ValueSet/concept-property-type|4.0.0"
}
},
{
"id" : "CodeSystem.concept",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "ConceptDefinition"
}],
"path" : "CodeSystem.concept",
"short" : "Concepts in the code system",
"definition" : "Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are.",
"comment" : "If this is empty, it means that the code system resource does not represent the content of the code system.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CodeSystem.concept",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CodeSystem.concept.id",
"path" : "CodeSystem.concept.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CodeSystem.concept.extension",
"path" : "CodeSystem.concept.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CodeSystem.concept.modifierExtension",
"path" : "CodeSystem.concept.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CodeSystem.concept.code",
"path" : "CodeSystem.concept.code",
"short" : "Code that identifies concept",
"definition" : "A code - a text symbol - that uniquely identifies the concept within the code system.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CodeSystem.concept.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CodeSystem.concept.display",
"path" : "CodeSystem.concept.display",
"short" : "Text to display to the user",
"definition" : "A human readable string that is the recommended default way to present this concept to a user.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeSystem.concept.display",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CodeSystem.concept.definition",
"path" : "CodeSystem.concept.definition",
"short" : "Formal definition",
"definition" : "The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeSystem.concept.definition",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CodeSystem.concept.designation",
"path" : "CodeSystem.concept.designation",
"short" : "Additional representations for the concept",
"definition" : "Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.",
"comment" : "Concepts have both a ```display``` and an array of ```designation```. The display is equivalent to a special designation with an implied ```designation.use``` of \"primary code\" and a language equal to the [Resource Language](resource.html#language).",
"requirements" : "Many concept definition systems support multiple representations, in multiple languages, and for multiple purposes.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CodeSystem.concept.designation",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CodeSystem.concept.designation.id",
"path" : "CodeSystem.concept.designation.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CodeSystem.concept.designation.extension",
"path" : "CodeSystem.concept.designation.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CodeSystem.concept.designation.modifierExtension",
"path" : "CodeSystem.concept.designation.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CodeSystem.concept.designation.language",
"path" : "CodeSystem.concept.designation.language",
"short" : "Human language of the designation",
"definition" : "The language this designation is defined for.",
"comment" : "In the absence of a language, the resource language applies.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeSystem.concept.designation.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "CodeSystem.concept.designation.use",
"path" : "CodeSystem.concept.designation.use",
"short" : "Details how this designation would be used",
"definition" : "A code that details how this designation would be used.",
"comment" : "If no use is provided, the designation can be assumed to be suitable for general display to a human user.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeSystem.concept.designation.use",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Coding"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConceptDesignationUse"
}],
"strength" : "extensible",
"description" : "Details of how a designation would be used.",
"valueSet" : "http://hl7.org/fhir/ValueSet/designation-use"
}
},
{
"id" : "CodeSystem.concept.designation.value",
"path" : "CodeSystem.concept.designation.value",
"short" : "The text value for this designation",
"definition" : "The text value for this designation.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CodeSystem.concept.designation.value",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CodeSystem.concept.property",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "ConceptProperty"
}],
"path" : "CodeSystem.concept.property",
"short" : "Property value for the concept",
"definition" : "A property value for this concept.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CodeSystem.concept.property",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CodeSystem.concept.property.id",
"path" : "CodeSystem.concept.property.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CodeSystem.concept.property.extension",
"path" : "CodeSystem.concept.property.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CodeSystem.concept.property.modifierExtension",
"path" : "CodeSystem.concept.property.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CodeSystem.concept.property.code",
"path" : "CodeSystem.concept.property.code",
"short" : "Reference to CodeSystem.property.code",
"definition" : "A code that is a reference to CodeSystem.property.code.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CodeSystem.concept.property.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CodeSystem.concept.property.value[x]",
"path" : "CodeSystem.concept.property.value[x]",
"short" : "Value of the property for this concept",
"definition" : "The value of this property.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CodeSystem.concept.property.value[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
},
{
"code" : "Coding"
},
{
"code" : "string"
},
{
"code" : "integer"
},
{
"code" : "boolean"
},
{
"code" : "dateTime"
},
{
"code" : "decimal"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CodeSystem.concept.concept",
"path" : "CodeSystem.concept.concept",
"short" : "Child Concepts (is-a/contains/categorizes)",
"definition" : "Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) - see hierarchyMeaning.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CodeSystem.concept.concept",
"min" : 0,
"max" : "*"
},
"contentReference" : "#CodeSystem.concept",
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "CodeSystem",
"path" : "CodeSystem",
"short" : "Declares the existence of and describes a code system or code system supplement",
"definition" : "The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "csd-1",
"severity" : "error",
"human" : "Within a code system definition, all the codes SHALL be unique",
"expression" : "concept.code.combine($this.descendants().concept.code).isDistinct()",
"xpath" : "count(distinct-values(descendant::f:concept/f:code/@value))=count(descendant::f:concept)"
},
{
"key" : "csd-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CodeSystem.url",
"path" : "CodeSystem.url",
"short" : "Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)",
"definition" : "An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this code system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the code system is stored on different servers. This is used in [Coding](datatypes.html#Coding).system.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the code system to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "CodeSystem.identifier",
"path" : "CodeSystem.identifier",
"short" : "Additional identifier for the code system (business identifier)",
"definition" : "A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this code system outside of FHIR, where it is not possible to use the logical URI. Note that HL7 defines at least three identifiers for many of its code systems - the FHIR canonical URL, the OID and the V2 Table 0396 mnemonic code.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "CodeSystem.version",
"path" : "CodeSystem.version",
"short" : "Business version of the code system (Coding.version)",
"definition" : "The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in [Coding](datatypes.html#Coding).version.",
"comment" : "There may be different code system instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the code system with the format [url]|[version].",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "CodeSystem.name",
"path" : "CodeSystem.name",
"short" : "Name for this code system (computer friendly)",
"definition" : "A natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isSummary" : true
},
{
"id" : "CodeSystem.title",
"path" : "CodeSystem.title",
"short" : "Name for this code system (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the code system.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "CodeSystem.status",
"path" : "CodeSystem.status",
"short" : "draft | active | retired | unknown",
"definition" : "The date (and optionally time) when the code system resource was created or revised.",
"comment" : "Allows filtering of code systems that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "CodeSystem.experimental",
"path" : "CodeSystem.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of code systems that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level code system.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "CodeSystem.date",
"path" : "CodeSystem.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the code system was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the code system changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the code system. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "CodeSystem.publisher",
"path" : "CodeSystem.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the code system.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the code system is the organization or individual primarily responsible for the maintenance and upkeep of the code system. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the code system. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the code system. May also allow for contact.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "CodeSystem.contact",
"path" : "CodeSystem.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "CodeSystem.description",
"path" : "CodeSystem.description",
"short" : "Natural language description of the code system",
"definition" : "A free text natural language description of the code system from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the code system was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the code system as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the code system is presumed to be the predominant language in the place the code system was created).",
"alias" : ["Scope",
"Purpose"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CodeSystem.useContext",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "CodeSystem.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate code system instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "CodeSystem.jurisdiction",
"path" : "CodeSystem.jurisdiction",
"short" : "Intended jurisdiction for code system (if applicable)",
"definition" : "A legal or geographic region in which the code system is intended to be used.",
"comment" : "It may be possible for the code system to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "CodeSystem.purpose",
"path" : "CodeSystem.purpose",
"short" : "Why this code system is defined",
"definition" : "Explanation of why this code system is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the code system. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this code system.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "CodeSystem.copyright",
"path" : "CodeSystem.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.",
"comment" : "... Sometimes, the copyright differs between the code system and the codes that are included. The copyright statement should clearly differentiate between these when required.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the code system and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "CodeSystem.caseSensitive",
"path" : "CodeSystem.caseSensitive",
"short" : "If code comparison is case sensitive",
"definition" : "If code comparison is case sensitive when codes within this system are compared to each other.",
"comment" : "If this value is missing, then it is not specified whether a code system is case sensitive or not. When the rule is not known, Postel's law should be followed: produce codes with the correct case, and accept codes in any case. This element is primarily provided to support validation software.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true
},
{
"id" : "CodeSystem.valueSet",
"path" : "CodeSystem.valueSet",
"short" : "Canonical reference to the value set with entire code system",
"definition" : "Canonical reference to the value set that contains the entire code system.",
"comment" : "The definition of the value set SHALL include all codes from this code system and only codes from this code system, and it SHALL be immutable.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"isSummary" : true
},
{
"id" : "CodeSystem.hierarchyMeaning",
"path" : "CodeSystem.hierarchyMeaning",
"short" : "grouped-by | is-a | part-of | classified-with",
"definition" : "The meaning of the hierarchy of concepts as represented in this resource.",
"comment" : "Note that other representations might have a different hierarchy or none at all, and represent the information using properties.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CodeSystemHierarchyMeaning"
}],
"strength" : "required",
"description" : "The meaning of the hierarchy of concepts in a code system.",
"valueSet" : "http://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning|4.0.0"
}
},
{
"id" : "CodeSystem.compositional",
"path" : "CodeSystem.compositional",
"short" : "If code system defines a compositional grammar",
"definition" : "The code system defines a compositional (post-coordination) grammar.",
"comment" : "Note that the code system resource does not define what the compositional grammar is, only whether or not there is one.",
"alias" : ["grammar"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true
},
{
"id" : "CodeSystem.versionNeeded",
"path" : "CodeSystem.versionNeeded",
"short" : "If definitions are not stable",
"definition" : "This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system.",
"comment" : "Best practice is that code systems do not redefine concepts, or that if concepts are redefined, a new code system definition is created. But this is not always possible, so some code systems may be defined as 'versionNeeded'.\n\nMost code systems occasionally refine the displays defined for concepts between versions. Contexts in which the concept display values are validated may require that the version be specified for some code systems irrespective of the value of this property.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true
},
{
"id" : "CodeSystem.content",
"path" : "CodeSystem.content",
"short" : "not-present | example | fragment | complete | supplement",
"definition" : "The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CodeSystemContentMode"
}],
"strength" : "required",
"description" : "The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.",
"valueSet" : "http://hl7.org/fhir/ValueSet/codesystem-content-mode|4.0.0"
}
},
{
"id" : "CodeSystem.supplements",
"path" : "CodeSystem.supplements",
"short" : "Canonical URL of Code System this adds designations and properties to",
"definition" : "The canonical URL of the code system that this code system supplement is adding designations and properties to.",
"comment" : "The most common use of a code system supplement is to add additional language support.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CodeSystem"]
}],
"isSummary" : true
},
{
"id" : "CodeSystem.count",
"path" : "CodeSystem.count",
"short" : "Total concepts in the code system",
"definition" : "The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward.",
"comment" : "The count of concepts defined in this resource cannot be more than this value but may be less for several reasons - see the content element.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "unsignedInt"
}],
"isSummary" : true
},
{
"id" : "CodeSystem.filter",
"path" : "CodeSystem.filter",
"short" : "Filter that can be used in a value set",
"definition" : "A filter that can be used in a value set compose statement when selecting concepts using a filter.",
"comment" : "Note that filters defined in code systems usually require custom code on the part of any terminology engine that will make them available for use in value set filters. For this reason, they are generally only seen in high value published terminologies.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "CodeSystem.filter.code",
"path" : "CodeSystem.filter.code",
"short" : "Code that identifies the filter",
"definition" : "The code that identifies this filter when it is used as a filter in [ValueSet](valueset.html#).compose.include.filter.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true
},
{
"id" : "CodeSystem.filter.description",
"path" : "CodeSystem.filter.description",
"short" : "How or why the filter is used",
"definition" : "A description of how or why the filter is used.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "CodeSystem.filter.operator",
"path" : "CodeSystem.filter.operator",
"short" : "Operators that can be used with filter",
"definition" : "A list of operators that can be used with the filter.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FilterOperator"
}],
"strength" : "required",
"description" : "The kind of operation to perform as a part of a property based filter.",
"valueSet" : "http://hl7.org/fhir/ValueSet/filter-operator|4.0.0"
}
},
{
"id" : "CodeSystem.filter.value",
"path" : "CodeSystem.filter.value",
"short" : "What to use for the value",
"definition" : "A description of what the value for the filter should be.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "CodeSystem.property",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Property"
}],
"path" : "CodeSystem.property",
"short" : "Additional information supplied about each concept",
"definition" : "A property defines an additional slot through which additional information can be provided about a concept.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "CodeSystem.property.code",
"path" : "CodeSystem.property.code",
"short" : "Identifies the property on the concepts, and when referred to in operations",
"definition" : "A code that is used to identify the property. The code is used internally (in CodeSystem.concept.property.code) and also externally, such as in property filters.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true
},
{
"id" : "CodeSystem.property.uri",
"path" : "CodeSystem.property.uri",
"short" : "Formal identifier for the property",
"definition" : "Reference to the formal meaning of the property. One possible source of meaning is the [Concept Properties](codesystem-concept-properties.html) code system.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true
},
{
"id" : "CodeSystem.property.description",
"path" : "CodeSystem.property.description",
"short" : "Why the property is defined, and/or what it conveys",
"definition" : "A description of the property- why it is defined, and how its value might be used.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "CodeSystem.property.type",
"path" : "CodeSystem.property.type",
"short" : "code | Coding | string | integer | boolean | dateTime | decimal",
"definition" : "The type of the property value. Properties of type \"code\" contain a code defined by the code system (e.g. a reference to another defined concept).",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PropertyType"
}],
"strength" : "required",
"description" : "The type of a property value.",
"valueSet" : "http://hl7.org/fhir/ValueSet/concept-property-type|4.0.0"
}
},
{
"id" : "CodeSystem.concept",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "ConceptDefinition"
}],
"path" : "CodeSystem.concept",
"short" : "Concepts in the code system",
"definition" : "Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are.",
"comment" : "If this is empty, it means that the code system resource does not represent the content of the code system.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "CodeSystem.concept.code",
"path" : "CodeSystem.concept.code",
"short" : "Code that identifies concept",
"definition" : "A code - a text symbol - that uniquely identifies the concept within the code system.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}]
},
{
"id" : "CodeSystem.concept.display",
"path" : "CodeSystem.concept.display",
"short" : "Text to display to the user",
"definition" : "A human readable string that is the recommended default way to present this concept to a user.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "CodeSystem.concept.definition",
"path" : "CodeSystem.concept.definition",
"short" : "Formal definition",
"definition" : "The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "CodeSystem.concept.designation",
"path" : "CodeSystem.concept.designation",
"short" : "Additional representations for the concept",
"definition" : "Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.",
"comment" : "Concepts have both a ```display``` and an array of ```designation```. The display is equivalent to a special designation with an implied ```designation.use``` of \"primary code\" and a language equal to the [Resource Language](resource.html#language).",
"requirements" : "Many concept definition systems support multiple representations, in multiple languages, and for multiple purposes.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "CodeSystem.concept.designation.language",
"path" : "CodeSystem.concept.designation.language",
"short" : "Human language of the designation",
"definition" : "The language this designation is defined for.",
"comment" : "In the absence of a language, the resource language applies.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "CodeSystem.concept.designation.use",
"path" : "CodeSystem.concept.designation.use",
"short" : "Details how this designation would be used",
"definition" : "A code that details how this designation would be used.",
"comment" : "If no use is provided, the designation can be assumed to be suitable for general display to a human user.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Coding"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConceptDesignationUse"
}],
"strength" : "extensible",
"description" : "Details of how a designation would be used.",
"valueSet" : "http://hl7.org/fhir/ValueSet/designation-use"
}
},
{
"id" : "CodeSystem.concept.designation.value",
"path" : "CodeSystem.concept.designation.value",
"short" : "The text value for this designation",
"definition" : "The text value for this designation.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "CodeSystem.concept.property",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "ConceptProperty"
}],
"path" : "CodeSystem.concept.property",
"short" : "Property value for the concept",
"definition" : "A property value for this concept.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "CodeSystem.concept.property.code",
"path" : "CodeSystem.concept.property.code",
"short" : "Reference to CodeSystem.property.code",
"definition" : "A code that is a reference to CodeSystem.property.code.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}]
},
{
"id" : "CodeSystem.concept.property.value[x]",
"path" : "CodeSystem.concept.property.value[x]",
"short" : "Value of the property for this concept",
"definition" : "The value of this property.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
},
{
"code" : "Coding"
},
{
"code" : "string"
},
{
"code" : "integer"
},
{
"code" : "boolean"
},
{
"code" : "dateTime"
},
{
"code" : "decimal"
}]
},
{
"id" : "CodeSystem.concept.concept",
"path" : "CodeSystem.concept.concept",
"short" : "Child Concepts (is-a/contains/categorizes)",
"definition" : "Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) - see hierarchyMeaning.",
"min" : 0,
"max" : "*",
"contentReference" : "#CodeSystem.concept"
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/Communication",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "Communication",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints Communication TU DomainResource A record of information transmitted from a sender to a receiver
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension \r\n identifier Σ 0..* Identifier Unique identifier
\r\n instantiatesCanonical Σ 0..* canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) Instantiates FHIR protocol or definition
\r\n instantiatesUri Σ 0..* uri Instantiates external protocol or definition
\r\n basedOn Σ 0..* Reference(Any) Request fulfilled by this communication
\r\n partOf Σ 0..* Reference(Any) Part of this action
\r\n inResponseTo 0..* Reference(Communication) Reply to
\r\n status ?!Σ 1..1 code preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error
EventStatus (Required) \r\n statusReason Σ 0..1 CodeableConcept Reason for current status
CommunicationNotDoneReason (Example) \r\n category 0..* CodeableConcept Message category
CommunicationCategory (Example)
\r\n priority Σ 0..1 code Message urgency
Request priority (Required) \r\n medium 0..* CodeableConcept A channel of communication
v3 Code System ParticipationMode (Example)
\r\n subject Σ 0..1 Reference(Patient | Group) Focus of message \r\n topic 0..1 CodeableConcept Description of the purpose/content
CommunicationTopic (Example) \r\n about 0..* Reference(Any) Resources that pertain to this communication
\r\n encounter Σ 0..1 Reference(Encounter) Encounter created as part of \r\n sent 0..1 dateTime When sent \r\n received 0..1 dateTime When received \r\n recipient 0..* Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) Message recipient
\r\n sender 0..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) Message sender \r\n reasonCode Σ 0..* CodeableConcept Indication for message
SNOMED CT Clinical Findings (Example)
\r\n reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why was communication done?
\r\n payload 0..* BackboneElement Message payload
\r\n content[x] 1..1 Message part content \r\n contentString string \r\n contentAttachment Attachment \r\n contentReference Reference(Any) \r\n note 0..* Annotation Comments made about the communication
\r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Request & Response"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pc"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Communication",
"version" : "4.0.0",
"name" : "Communication",
"status" : "draft",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (Patient Care)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}]
}],
"description" : "An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Communication",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Communication",
"path" : "Communication",
"short" : "A record of information transmitted from a sender to a receiver",
"definition" : "An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Communication",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Event"
}]
},
{
"id" : "Communication.id",
"path" : "Communication.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Communication.meta",
"path" : "Communication.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Communication.implicitRules",
"path" : "Communication.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Communication.language",
"path" : "Communication.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Communication.text",
"path" : "Communication.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Communication.contained",
"path" : "Communication.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Communication.extension",
"path" : "Communication.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Communication.modifierExtension",
"path" : "Communication.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Communication.identifier",
"path" : "Communication.identifier",
"short" : "Unique identifier",
"definition" : "Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.",
"comment" : "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"requirements" : "Allows identification of the communication as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Communication.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "Communication.instantiatesCanonical",
"path" : "Communication.instantiatesCanonical",
"short" : "Instantiates FHIR protocol or definition",
"definition" : "The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Communication.instantiatesCanonical",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"http://hl7.org/fhir/StructureDefinition/Measure",
"http://hl7.org/fhir/StructureDefinition/OperationDefinition",
"http://hl7.org/fhir/StructureDefinition/Questionnaire"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.instantiatesCanonical"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "Communication.instantiatesUri",
"path" : "Communication.instantiatesUri",
"short" : "Instantiates external protocol or definition",
"definition" : "The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.",
"comment" : "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Communication.instantiatesUri",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.instantiatesUri"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "Communication.basedOn",
"path" : "Communication.basedOn",
"short" : "Request fulfilled by this communication",
"definition" : "An order, proposal or plan fulfilled in whole or in part by this Communication.",
"comment" : "This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ServiceRequest, MedicationRequest, etc.",
"alias" : ["fulfills"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Communication.basedOn",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
}]
},
{
"id" : "Communication.partOf",
"path" : "Communication.partOf",
"short" : "Part of this action",
"definition" : "Part of this action.",
"alias" : ["container"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Communication.partOf",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
}]
},
{
"id" : "Communication.inResponseTo",
"path" : "Communication.inResponseTo",
"short" : "Reply to",
"definition" : "Prior communication that this communication is in response to.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Communication.inResponseTo",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Communication"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Communication.status",
"path" : "Communication.status",
"short" : "preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error",
"definition" : "The status of the transmission.",
"comment" : "This element is labeled as a modifier because the status contains the codes aborted and entered-in-error that mark the communication as not currently valid.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Communication.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationStatus"
}],
"strength" : "required",
"description" : "The status of the communication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/event-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "Communication.statusReason",
"path" : "Communication.statusReason",
"short" : "Reason for current status",
"definition" : "Captures the reason for the current state of the Communication.",
"comment" : "This is generally only used for \"exception\" statuses such as \"not-done\", \"suspended\" or \"aborted\". The reason for performing the event at all is captured in reasonCode, not here.",
"alias" : ["Suspended Reason",
"Cancelled Reason"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Communication.statusReason",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationNotDoneReason"
}],
"strength" : "example",
"description" : "Codes for the reason why a communication did not happen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/communication-not-done-reason"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.statusReason"
}]
},
{
"id" : "Communication.category",
"path" : "Communication.category",
"short" : "Message category",
"definition" : "The type of message conveyed such as alert, notification, reminder, instruction, etc.",
"comment" : "There may be multiple axes of categorization and one communication may serve multiple purposes.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Communication.category",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationCategory"
}],
"strength" : "example",
"description" : "Codes for general categories of communications such as alerts, instructions, etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/communication-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Communication.priority",
"path" : "Communication.priority",
"short" : "Message urgency",
"definition" : "Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.",
"comment" : "Used to prioritize workflow (such as which communication to read first) when the communication is planned or in progress.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Communication.priority",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"meaningWhenMissing" : "If missing, this communication should be treated with normal priority",
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationPriority"
}],
"strength" : "required",
"description" : "Codes indicating the relative importance of a communication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-priority|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.grade"
}]
},
{
"id" : "Communication.medium",
"path" : "Communication.medium",
"short" : "A channel of communication",
"definition" : "A channel that was used for this communication (e.g. email, fax).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Communication.medium",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationMedium"
}],
"strength" : "example",
"description" : "Codes for communication mediums such as phone, fax, email, in person, etc.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationMode"
}
},
{
"id" : "Communication.subject",
"path" : "Communication.subject",
"short" : "Focus of message",
"definition" : "The patient or group that was the focus of this communication.",
"alias" : ["patient"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Communication.subject",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Communication.topic",
"path" : "Communication.topic",
"short" : "Description of the purpose/content",
"definition" : "Description of the purpose/content, similar to a subject line in an email.",
"comment" : "Communication.topic.text can be used without any codings.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Communication.topic",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationTopic"
}],
"strength" : "example",
"description" : "Codes describing the purpose or content of the communication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/communication-topic"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
}]
},
{
"id" : "Communication.about",
"path" : "Communication.about",
"short" : "Resources that pertain to this communication",
"definition" : "Other resources that pertain to this communication and to which this communication should be associated.",
"comment" : "Don't use Communication.about element when a more specific element exists, such as basedOn or reasonReference.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Communication.about",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
}]
},
{
"id" : "Communication.encounter",
"path" : "Communication.encounter",
"short" : "Encounter created as part of",
"definition" : "The Encounter during which this Communication was created or to which the creation of this record is tightly associated.",
"comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Communication.encounter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.context"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
}]
},
{
"id" : "Communication.sent",
"path" : "Communication.sent",
"short" : "When sent",
"definition" : "The time when this communication was sent.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Communication.sent",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x] {Invariant: maps to period.start}"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
}]
},
{
"id" : "Communication.received",
"path" : "Communication.received",
"short" : "When received",
"definition" : "The time when this communication arrived at the destination.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Communication.received",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x] {Invariant: maps to period.end}"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
}]
},
{
"id" : "Communication.recipient",
"path" : "Communication.recipient",
"short" : "Message recipient",
"definition" : "The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Communication.recipient",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Group",
"http://hl7.org/fhir/StructureDefinition/CareTeam",
"http://hl7.org/fhir/StructureDefinition/HealthcareService"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
}]
},
{
"id" : "Communication.sender",
"path" : "Communication.sender",
"short" : "Message sender",
"definition" : "The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Communication.sender",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/HealthcareService"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
}]
},
{
"id" : "Communication.reasonCode",
"path" : "Communication.reasonCode",
"short" : "Indication for message",
"definition" : "The reason or justification for the communication.",
"comment" : "Textual reasons can be captured using reasonCode.text.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Communication.reasonCode",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationReason"
}],
"strength" : "example",
"description" : "Codes for describing reasons for the occurrence of a communication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/clinical-findings"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".reasonCode"
}]
},
{
"id" : "Communication.reasonReference",
"path" : "Communication.reasonReference",
"short" : "Why was communication done?",
"definition" : "Indicates another resource whose existence justifies this communication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Communication.reasonReference",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonReference"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RSON].target"
}]
},
{
"id" : "Communication.payload",
"path" : "Communication.payload",
"short" : "Message payload",
"definition" : "Text, attachment(s), or resource(s) that was communicated to the recipient.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Communication.payload",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Communication.payload.id",
"path" : "Communication.payload.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Communication.payload.extension",
"path" : "Communication.payload.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Communication.payload.modifierExtension",
"path" : "Communication.payload.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Communication.payload.content[x]",
"path" : "Communication.payload.content[x]",
"short" : "Message part content",
"definition" : "A communicated content (or for multi-part communications, one portion of the communication).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Communication.payload.content[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
},
{
"code" : "Attachment"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Communication.note",
"path" : "Communication.note",
"short" : "Comments made about the communication",
"definition" : "Additional notes or commentary about the communication by the sender, receiver or other interested parties.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Communication.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
}]
}]
},
"differential" : {
"element" : [{
"id" : "Communication",
"path" : "Communication",
"short" : "A record of information transmitted from a sender to a receiver",
"definition" : "An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Event"
}]
},
{
"id" : "Communication.identifier",
"path" : "Communication.identifier",
"short" : "Unique identifier",
"definition" : "Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.",
"comment" : "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"requirements" : "Allows identification of the communication as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "Communication.instantiatesCanonical",
"path" : "Communication.instantiatesCanonical",
"short" : "Instantiates FHIR protocol or definition",
"definition" : "The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"http://hl7.org/fhir/StructureDefinition/Measure",
"http://hl7.org/fhir/StructureDefinition/OperationDefinition",
"http://hl7.org/fhir/StructureDefinition/Questionnaire"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.instantiatesCanonical"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "Communication.instantiatesUri",
"path" : "Communication.instantiatesUri",
"short" : "Instantiates external protocol or definition",
"definition" : "The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.",
"comment" : "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.instantiatesUri"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "Communication.basedOn",
"path" : "Communication.basedOn",
"short" : "Request fulfilled by this communication",
"definition" : "An order, proposal or plan fulfilled in whole or in part by this Communication.",
"comment" : "This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ServiceRequest, MedicationRequest, etc.",
"alias" : ["fulfills"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
}]
},
{
"id" : "Communication.partOf",
"path" : "Communication.partOf",
"short" : "Part of this action",
"definition" : "Part of this action.",
"alias" : ["container"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
}]
},
{
"id" : "Communication.inResponseTo",
"path" : "Communication.inResponseTo",
"short" : "Reply to",
"definition" : "Prior communication that this communication is in response to.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Communication"]
}]
},
{
"id" : "Communication.status",
"path" : "Communication.status",
"short" : "preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error",
"definition" : "The status of the transmission.",
"comment" : "This element is labeled as a modifier because the status contains the codes aborted and entered-in-error that mark the communication as not currently valid.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationStatus"
}],
"strength" : "required",
"description" : "The status of the communication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/event-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "Communication.statusReason",
"path" : "Communication.statusReason",
"short" : "Reason for current status",
"definition" : "Captures the reason for the current state of the Communication.",
"comment" : "This is generally only used for \"exception\" statuses such as \"not-done\", \"suspended\" or \"aborted\". The reason for performing the event at all is captured in reasonCode, not here.",
"alias" : ["Suspended Reason",
"Cancelled Reason"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationNotDoneReason"
}],
"strength" : "example",
"description" : "Codes for the reason why a communication did not happen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/communication-not-done-reason"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.statusReason"
}]
},
{
"id" : "Communication.category",
"path" : "Communication.category",
"short" : "Message category",
"definition" : "The type of message conveyed such as alert, notification, reminder, instruction, etc.",
"comment" : "There may be multiple axes of categorization and one communication may serve multiple purposes.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationCategory"
}],
"strength" : "example",
"description" : "Codes for general categories of communications such as alerts, instructions, etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/communication-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Communication.priority",
"path" : "Communication.priority",
"short" : "Message urgency",
"definition" : "Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.",
"comment" : "Used to prioritize workflow (such as which communication to read first) when the communication is planned or in progress.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"meaningWhenMissing" : "If missing, this communication should be treated with normal priority",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationPriority"
}],
"strength" : "required",
"description" : "Codes indicating the relative importance of a communication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-priority|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.grade"
}]
},
{
"id" : "Communication.medium",
"path" : "Communication.medium",
"short" : "A channel of communication",
"definition" : "A channel that was used for this communication (e.g. email, fax).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationMedium"
}],
"strength" : "example",
"description" : "Codes for communication mediums such as phone, fax, email, in person, etc.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationMode"
}
},
{
"id" : "Communication.subject",
"path" : "Communication.subject",
"short" : "Focus of message",
"definition" : "The patient or group that was the focus of this communication.",
"alias" : ["patient"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Communication.topic",
"path" : "Communication.topic",
"short" : "Description of the purpose/content",
"definition" : "Description of the purpose/content, similar to a subject line in an email.",
"comment" : "Communication.topic.text can be used without any codings.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationTopic"
}],
"strength" : "example",
"description" : "Codes describing the purpose or content of the communication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/communication-topic"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
}]
},
{
"id" : "Communication.about",
"path" : "Communication.about",
"short" : "Resources that pertain to this communication",
"definition" : "Other resources that pertain to this communication and to which this communication should be associated.",
"comment" : "Don't use Communication.about element when a more specific element exists, such as basedOn or reasonReference.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
}]
},
{
"id" : "Communication.encounter",
"path" : "Communication.encounter",
"short" : "Encounter created as part of",
"definition" : "The Encounter during which this Communication was created or to which the creation of this record is tightly associated.",
"comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.context"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
}]
},
{
"id" : "Communication.sent",
"path" : "Communication.sent",
"short" : "When sent",
"definition" : "The time when this communication was sent.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x] {Invariant: maps to period.start}"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
}]
},
{
"id" : "Communication.received",
"path" : "Communication.received",
"short" : "When received",
"definition" : "The time when this communication arrived at the destination.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x] {Invariant: maps to period.end}"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
}]
},
{
"id" : "Communication.recipient",
"path" : "Communication.recipient",
"short" : "Message recipient",
"definition" : "The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Group",
"http://hl7.org/fhir/StructureDefinition/CareTeam",
"http://hl7.org/fhir/StructureDefinition/HealthcareService"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
}]
},
{
"id" : "Communication.sender",
"path" : "Communication.sender",
"short" : "Message sender",
"definition" : "The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/HealthcareService"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
}]
},
{
"id" : "Communication.reasonCode",
"path" : "Communication.reasonCode",
"short" : "Indication for message",
"definition" : "The reason or justification for the communication.",
"comment" : "Textual reasons can be captured using reasonCode.text.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationReason"
}],
"strength" : "example",
"description" : "Codes for describing reasons for the occurrence of a communication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/clinical-findings"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".reasonCode"
}]
},
{
"id" : "Communication.reasonReference",
"path" : "Communication.reasonReference",
"short" : "Why was communication done?",
"definition" : "Indicates another resource whose existence justifies this communication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonReference"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RSON].target"
}]
},
{
"id" : "Communication.payload",
"path" : "Communication.payload",
"short" : "Message payload",
"definition" : "Text, attachment(s), or resource(s) that was communicated to the recipient.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "Communication.payload.content[x]",
"path" : "Communication.payload.content[x]",
"short" : "Message part content",
"definition" : "A communicated content (or for multi-part communications, one portion of the communication).",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
},
{
"code" : "Attachment"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}]
},
{
"id" : "Communication.note",
"path" : "Communication.note",
"short" : "Comments made about the communication",
"definition" : "Additional notes or commentary about the communication by the sender, receiver or other interested parties.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/CommunicationRequest",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "CommunicationRequest",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints CommunicationRequest TU DomainResource A request for information to be sent to a receiver
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension \r\n identifier Σ 0..* Identifier Unique identifier
\r\n basedOn Σ 0..* Reference(Any) Fulfills plan or proposal
\r\n replaces Σ 0..* Reference(CommunicationRequest) Request(s) replaced by this request
\r\n groupIdentifier Σ 0..1 Identifier Composite request this is part of \r\n status ?!Σ 1..1 code draft | active | suspended | cancelled | completed | entered-in-error | unknown
RequestStatus (Required) \r\n statusReason 0..1 CodeableConcept Reason for current status \r\n category 0..* CodeableConcept Message category
CommunicationCategory (Example)
\r\n priority Σ 0..1 code Message urgency
Request priority (Required) \r\n doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action \r\n medium 0..* CodeableConcept A channel of communication
v3 Code System ParticipationMode (Example)
\r\n subject 0..1 Reference(Patient | Group) Focus of message \r\n about 0..* Reference(Any) Resources that pertain to this communication request
\r\n encounter Σ 0..1 Reference(Encounter) Encounter created as part of \r\n payload 0..* BackboneElement Message payload
\r\n content[x] 1..1 Message part content \r\n contentString string \r\n contentAttachment Attachment \r\n contentReference Reference(Any) \r\n occurrence[x] Σ 0..1 When scheduled \r\n occurrenceDateTime dateTime \r\n occurrencePeriod Period \r\n authoredOn Σ 0..1 dateTime When request transitioned to being actionable \r\n requester Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service \r\n recipient 0..* Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) Message recipient
\r\n sender Σ 0..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) Message sender \r\n reasonCode Σ 0..* CodeableConcept Why is communication needed?
v3 Code System ActReason (Example)
\r\n reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why is communication needed?
\r\n note 0..* Annotation Comments made about communication request
\r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Request & Response"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pc"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/CommunicationRequest",
"version" : "4.0.0",
"name" : "CommunicationRequest",
"status" : "draft",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (Patient Care)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}]
}],
"description" : "A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "CommunicationRequest",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "CommunicationRequest",
"path" : "CommunicationRequest",
"short" : "A request for information to be sent to a receiver",
"definition" : "A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CommunicationRequest",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Request"
}]
},
{
"id" : "CommunicationRequest.id",
"path" : "CommunicationRequest.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CommunicationRequest.meta",
"path" : "CommunicationRequest.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CommunicationRequest.implicitRules",
"path" : "CommunicationRequest.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "CommunicationRequest.language",
"path" : "CommunicationRequest.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "CommunicationRequest.text",
"path" : "CommunicationRequest.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "CommunicationRequest.contained",
"path" : "CommunicationRequest.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CommunicationRequest.extension",
"path" : "CommunicationRequest.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CommunicationRequest.modifierExtension",
"path" : "CommunicationRequest.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CommunicationRequest.identifier",
"path" : "CommunicationRequest.identifier",
"short" : "Unique identifier",
"definition" : "Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.",
"comment" : "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"requirements" : "Allows identification of the communication request as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CommunicationRequest.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "CommunicationRequest.basedOn",
"path" : "CommunicationRequest.basedOn",
"short" : "Fulfills plan or proposal",
"definition" : "A plan or proposal that is fulfilled in whole or in part by this request.",
"requirements" : "Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.",
"alias" : ["fulfills"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "CommunicationRequest.basedOn",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.basedOn"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target"
}]
},
{
"id" : "CommunicationRequest.replaces",
"path" : "CommunicationRequest.replaces",
"short" : "Request(s) replaced by this request",
"definition" : "Completed or terminated request(s) whose function is taken by this new request.",
"comment" : "The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.",
"requirements" : "Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.",
"alias" : ["supersedes",
"prior"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "CommunicationRequest.replaces",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CommunicationRequest"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.replaces"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RPLC].target"
}]
},
{
"id" : "CommunicationRequest.groupIdentifier",
"path" : "CommunicationRequest.groupIdentifier",
"short" : "Composite request this is part of",
"definition" : "A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.",
"comment" : "Requests are linked either by a \"basedOn\" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.",
"alias" : ["grouperId"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "CommunicationRequest.groupIdentifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.groupIdentifier"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=COMP].source[moodCode=INT].identifier"
}]
},
{
"id" : "CommunicationRequest.status",
"path" : "CommunicationRequest.status",
"short" : "draft | active | suspended | cancelled | completed | entered-in-error | unknown",
"definition" : "The status of the proposal or order.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CommunicationRequest.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid.",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationRequestStatus"
}],
"strength" : "required",
"description" : "The status of the communication request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "CommunicationRequest.statusReason",
"path" : "CommunicationRequest.statusReason",
"short" : "Reason for current status",
"definition" : "Captures the reason for the current state of the CommunicationRequest.",
"comment" : "This is generally only used for \"exception\" statuses such as \"suspended\" or \"cancelled\". The reason why the CommunicationRequest was created at all is captured in reasonCode, not here. [distinct reason codes for different statuses can be enforced using invariants if they are universal bindings].",
"alias" : ["Suspended Reason",
"Cancelled Reason"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "CommunicationRequest.statusReason",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationRequestStatusReason"
}],
"strength" : "example",
"description" : "Codes identifying the reason for the current state of a request."
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.statusReason"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde"
}]
},
{
"id" : "CommunicationRequest.category",
"path" : "CommunicationRequest.category",
"short" : "Message category",
"definition" : "The type of message to be sent such as alert, notification, reminder, instruction, etc.",
"comment" : "There may be multiple axes of categorization and one communication request may serve multiple purposes.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CommunicationRequest.category",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationCategory"
}],
"strength" : "example",
"description" : "Codes for general categories of communications such as alerts, instruction, etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/communication-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "CommunicationRequest.priority",
"path" : "CommunicationRequest.priority",
"short" : "Message urgency",
"definition" : "Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CommunicationRequest.priority",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"meaningWhenMissing" : "If missing, this task should be performed with normal priority",
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationPriority"
}],
"strength" : "required",
"description" : "Codes indicating the relative importance of a communication request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-priority|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.priority"
},
{
"identity" : "w5",
"map" : "FiveWs.grade"
}]
},
{
"id" : "CommunicationRequest.doNotPerform",
"path" : "CommunicationRequest.doNotPerform",
"short" : "True if request is prohibiting action",
"definition" : "If true indicates that the CommunicationRequest is asking for the specified action to *not* occur.",
"comment" : "The attributes provided with the request qualify what is not to be done.",
"alias" : ["prohibited"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "CommunicationRequest.doNotPerform",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "If do not perform is not specified, the request is a positive request e.g. \"do perform\"",
"isModifier" : true,
"isModifierReason" : "If true this element negates the specified action. For Example, instead of a request for a communication, it is a request for the communication to not occur.",
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.doNotPerform"
}]
},
{
"id" : "CommunicationRequest.medium",
"path" : "CommunicationRequest.medium",
"short" : "A channel of communication",
"definition" : "A channel that was used for this communication (e.g. email, fax).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CommunicationRequest.medium",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationMedium"
}],
"strength" : "example",
"description" : "Codes for communication mediums such as phone, fax, email, in person, etc.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationMode"
}
},
{
"id" : "CommunicationRequest.subject",
"path" : "CommunicationRequest.subject",
"short" : "Focus of message",
"definition" : "The patient or group that is the focus of this communication request.",
"alias" : ["patient"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "CommunicationRequest.subject",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "CommunicationRequest.about",
"path" : "CommunicationRequest.about",
"short" : "Resources that pertain to this communication request",
"definition" : "Other resources that pertain to this communication request and to which this communication request should be associated.",
"comment" : "Don't use CommunicationRequest.about element when a more specific element exists, such as basedOn, reasonReference, or replaces.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CommunicationRequest.about",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.supportingInfo"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
}]
},
{
"id" : "CommunicationRequest.encounter",
"path" : "CommunicationRequest.encounter",
"short" : "Encounter created as part of",
"definition" : "The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.",
"comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CommunicationRequest.encounter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.context"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
}]
},
{
"id" : "CommunicationRequest.payload",
"path" : "CommunicationRequest.payload",
"short" : "Message payload",
"definition" : "Text, attachment(s), or resource(s) to be communicated to the recipient.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CommunicationRequest.payload",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CommunicationRequest.payload.id",
"path" : "CommunicationRequest.payload.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CommunicationRequest.payload.extension",
"path" : "CommunicationRequest.payload.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CommunicationRequest.payload.modifierExtension",
"path" : "CommunicationRequest.payload.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CommunicationRequest.payload.content[x]",
"path" : "CommunicationRequest.payload.content[x]",
"short" : "Message part content",
"definition" : "The communicated content (or for multi-part communications, one portion of the communication).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CommunicationRequest.payload.content[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
},
{
"code" : "Attachment"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.note"
}]
},
{
"id" : "CommunicationRequest.occurrence[x]",
"path" : "CommunicationRequest.occurrence[x]",
"short" : "When scheduled",
"definition" : "The time when this communication is to occur.",
"alias" : ["timing"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "CommunicationRequest.occurrence[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.planned"
}]
},
{
"id" : "CommunicationRequest.authoredOn",
"path" : "CommunicationRequest.authoredOn",
"short" : "When request transitioned to being actionable",
"definition" : "For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.",
"alias" : ["createdOn"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "CommunicationRequest.authoredOn",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.authoredOn"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "CommunicationRequest.requester",
"path" : "CommunicationRequest.requester",
"short" : "Who/what is requesting service",
"definition" : "The device, individual, or organization who initiated the request and has responsibility for its activation.",
"alias" : ["author"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "CommunicationRequest.requester",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.requester"
},
{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
}]
},
{
"id" : "CommunicationRequest.recipient",
"path" : "CommunicationRequest.recipient",
"short" : "Message recipient",
"definition" : "The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CommunicationRequest.recipient",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Group",
"http://hl7.org/fhir/StructureDefinition/CareTeam",
"http://hl7.org/fhir/StructureDefinition/HealthcareService"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
}]
},
{
"id" : "CommunicationRequest.sender",
"path" : "CommunicationRequest.sender",
"short" : "Message sender",
"definition" : "The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CommunicationRequest.sender",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/HealthcareService"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
}]
},
{
"id" : "CommunicationRequest.reasonCode",
"path" : "CommunicationRequest.reasonCode",
"short" : "Why is communication needed?",
"definition" : "Describes why the request is being made in coded or textual form.",
"comment" : "Textual reasons can be captured using reasonCode.text.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CommunicationRequest.reasonCode",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationReason"
}],
"strength" : "example",
"description" : "Codes for describing reasons for the occurrence of a communication.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActReason"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".reasonCode"
}]
},
{
"id" : "CommunicationRequest.reasonReference",
"path" : "CommunicationRequest.reasonReference",
"short" : "Why is communication needed?",
"definition" : "Indicates another resource whose existence justifies this request.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CommunicationRequest.reasonReference",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonReference"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RSON].target"
}]
},
{
"id" : "CommunicationRequest.note",
"path" : "CommunicationRequest.note",
"short" : "Comments made about communication request",
"definition" : "Comments made about the request by the requester, sender, recipient, subject or other participants.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CommunicationRequest.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.note"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]"
}]
}]
},
"differential" : {
"element" : [{
"id" : "CommunicationRequest",
"path" : "CommunicationRequest",
"short" : "A request for information to be sent to a receiver",
"definition" : "A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Request"
}]
},
{
"id" : "CommunicationRequest.identifier",
"path" : "CommunicationRequest.identifier",
"short" : "Unique identifier",
"definition" : "Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.",
"comment" : "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"requirements" : "Allows identification of the communication request as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "CommunicationRequest.basedOn",
"path" : "CommunicationRequest.basedOn",
"short" : "Fulfills plan or proposal",
"definition" : "A plan or proposal that is fulfilled in whole or in part by this request.",
"requirements" : "Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.",
"alias" : ["fulfills"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.basedOn"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target"
}]
},
{
"id" : "CommunicationRequest.replaces",
"path" : "CommunicationRequest.replaces",
"short" : "Request(s) replaced by this request",
"definition" : "Completed or terminated request(s) whose function is taken by this new request.",
"comment" : "The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.",
"requirements" : "Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.",
"alias" : ["supersedes",
"prior"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CommunicationRequest"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.replaces"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RPLC].target"
}]
},
{
"id" : "CommunicationRequest.groupIdentifier",
"path" : "CommunicationRequest.groupIdentifier",
"short" : "Composite request this is part of",
"definition" : "A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.",
"comment" : "Requests are linked either by a \"basedOn\" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.",
"alias" : ["grouperId"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.groupIdentifier"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=COMP].source[moodCode=INT].identifier"
}]
},
{
"id" : "CommunicationRequest.status",
"path" : "CommunicationRequest.status",
"short" : "draft | active | suspended | cancelled | completed | entered-in-error | unknown",
"definition" : "The status of the proposal or order.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid.",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationRequestStatus"
}],
"strength" : "required",
"description" : "The status of the communication request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "CommunicationRequest.statusReason",
"path" : "CommunicationRequest.statusReason",
"short" : "Reason for current status",
"definition" : "Captures the reason for the current state of the CommunicationRequest.",
"comment" : "This is generally only used for \"exception\" statuses such as \"suspended\" or \"cancelled\". The reason why the CommunicationRequest was created at all is captured in reasonCode, not here. [distinct reason codes for different statuses can be enforced using invariants if they are universal bindings].",
"alias" : ["Suspended Reason",
"Cancelled Reason"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationRequestStatusReason"
}],
"strength" : "example",
"description" : "Codes identifying the reason for the current state of a request."
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.statusReason"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde"
}]
},
{
"id" : "CommunicationRequest.category",
"path" : "CommunicationRequest.category",
"short" : "Message category",
"definition" : "The type of message to be sent such as alert, notification, reminder, instruction, etc.",
"comment" : "There may be multiple axes of categorization and one communication request may serve multiple purposes.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationCategory"
}],
"strength" : "example",
"description" : "Codes for general categories of communications such as alerts, instruction, etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/communication-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "CommunicationRequest.priority",
"path" : "CommunicationRequest.priority",
"short" : "Message urgency",
"definition" : "Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"meaningWhenMissing" : "If missing, this task should be performed with normal priority",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationPriority"
}],
"strength" : "required",
"description" : "Codes indicating the relative importance of a communication request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-priority|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.priority"
},
{
"identity" : "w5",
"map" : "FiveWs.grade"
}]
},
{
"id" : "CommunicationRequest.doNotPerform",
"path" : "CommunicationRequest.doNotPerform",
"short" : "True if request is prohibiting action",
"definition" : "If true indicates that the CommunicationRequest is asking for the specified action to *not* occur.",
"comment" : "The attributes provided with the request qualify what is not to be done.",
"alias" : ["prohibited"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "If do not perform is not specified, the request is a positive request e.g. \"do perform\"",
"isModifier" : true,
"isModifierReason" : "If true this element negates the specified action. For Example, instead of a request for a communication, it is a request for the communication to not occur.",
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.doNotPerform"
}]
},
{
"id" : "CommunicationRequest.medium",
"path" : "CommunicationRequest.medium",
"short" : "A channel of communication",
"definition" : "A channel that was used for this communication (e.g. email, fax).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationMedium"
}],
"strength" : "example",
"description" : "Codes for communication mediums such as phone, fax, email, in person, etc.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationMode"
}
},
{
"id" : "CommunicationRequest.subject",
"path" : "CommunicationRequest.subject",
"short" : "Focus of message",
"definition" : "The patient or group that is the focus of this communication request.",
"alias" : ["patient"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "CommunicationRequest.about",
"path" : "CommunicationRequest.about",
"short" : "Resources that pertain to this communication request",
"definition" : "Other resources that pertain to this communication request and to which this communication request should be associated.",
"comment" : "Don't use CommunicationRequest.about element when a more specific element exists, such as basedOn, reasonReference, or replaces.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.supportingInfo"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
}]
},
{
"id" : "CommunicationRequest.encounter",
"path" : "CommunicationRequest.encounter",
"short" : "Encounter created as part of",
"definition" : "The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.",
"comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.context"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
}]
},
{
"id" : "CommunicationRequest.payload",
"path" : "CommunicationRequest.payload",
"short" : "Message payload",
"definition" : "Text, attachment(s), or resource(s) to be communicated to the recipient.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "CommunicationRequest.payload.content[x]",
"path" : "CommunicationRequest.payload.content[x]",
"short" : "Message part content",
"definition" : "The communicated content (or for multi-part communications, one portion of the communication).",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
},
{
"code" : "Attachment"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.note"
}]
},
{
"id" : "CommunicationRequest.occurrence[x]",
"path" : "CommunicationRequest.occurrence[x]",
"short" : "When scheduled",
"definition" : "The time when this communication is to occur.",
"alias" : ["timing"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.planned"
}]
},
{
"id" : "CommunicationRequest.authoredOn",
"path" : "CommunicationRequest.authoredOn",
"short" : "When request transitioned to being actionable",
"definition" : "For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.",
"alias" : ["createdOn"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.authoredOn"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "CommunicationRequest.requester",
"path" : "CommunicationRequest.requester",
"short" : "Who/what is requesting service",
"definition" : "The device, individual, or organization who initiated the request and has responsibility for its activation.",
"alias" : ["author"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.requester"
},
{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
}]
},
{
"id" : "CommunicationRequest.recipient",
"path" : "CommunicationRequest.recipient",
"short" : "Message recipient",
"definition" : "The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Group",
"http://hl7.org/fhir/StructureDefinition/CareTeam",
"http://hl7.org/fhir/StructureDefinition/HealthcareService"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
}]
},
{
"id" : "CommunicationRequest.sender",
"path" : "CommunicationRequest.sender",
"short" : "Message sender",
"definition" : "The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/HealthcareService"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
}]
},
{
"id" : "CommunicationRequest.reasonCode",
"path" : "CommunicationRequest.reasonCode",
"short" : "Why is communication needed?",
"definition" : "Describes why the request is being made in coded or textual form.",
"comment" : "Textual reasons can be captured using reasonCode.text.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CommunicationReason"
}],
"strength" : "example",
"description" : "Codes for describing reasons for the occurrence of a communication.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActReason"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".reasonCode"
}]
},
{
"id" : "CommunicationRequest.reasonReference",
"path" : "CommunicationRequest.reasonReference",
"short" : "Why is communication needed?",
"definition" : "Indicates another resource whose existence justifies this request.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonReference"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RSON].target"
}]
},
{
"id" : "CommunicationRequest.note",
"path" : "CommunicationRequest.note",
"short" : "Comments made about communication request",
"definition" : "Comments made about the request by the requester, sender, recipient, subject or other participants.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.note"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/CompartmentDefinition",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "CompartmentDefinition",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints CompartmentDefinition ITU DomainResource Compartment Definition for a resource
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension \r\n url Σ 1..1 uri Canonical identifier for this compartment definition, represented as a URI (globally unique) \r\n version Σ 0..1 string Business version of the compartment definition \r\n name ΣI 1..1 string Name for this compartment definition (computer friendly) \r\n status ?!Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required) \r\n experimental Σ 0..1 boolean For testing purposes, not real usage \r\n date Σ 0..1 dateTime Date last changed \r\n publisher Σ 0..1 string Name of the publisher (organization or individual) \r\n contact Σ 0..* ContactDetail Contact details for the publisher
\r\n description 0..1 markdown Natural language description of the compartment definition \r\n useContext Σ 0..* UsageContext The context that the content is intended to support
\r\n purpose 0..1 markdown Why this compartment definition is defined \r\n code Σ 1..1 code Patient | Encounter | RelatedPerson | Practitioner | Device
CompartmentType (Required) \r\n search Σ 1..1 boolean Whether the search syntax is supported \r\n resource Σ 0..* BackboneElement How a resource is related to the compartment
\r\n code Σ 1..1 code Name of resource type
ResourceType (Required) \r\n param Σ 0..* string Search Parameter Name, or chained parameters
\r\n documentation 0..1 string Additional documentation about the resource and compartment \r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Conformance"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/CompartmentDefinition",
"version" : "4.0.0",
"name" : "CompartmentDefinition",
"status" : "draft",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}]
}],
"description" : "A compartment definition that defines how resources are accessed on a server.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "objimpl",
"uri" : "http://hl7.org/fhir/object-implementation",
"name" : "Object Implementation Information"
}],
"kind" : "resource",
"abstract" : false,
"type" : "CompartmentDefinition",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString" : "MetadataResource"
}]
},
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "CompartmentDefinition",
"path" : "CompartmentDefinition",
"short" : "Compartment Definition for a resource",
"definition" : "A compartment definition that defines how resources are accessed on a server.",
"comment" : "In FHIR, search is not performed directly on a resource (by XML or JSON path), but on a named parameter that maps into the resource content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CompartmentDefinition",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
},
{
"key" : "cpd-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "v2",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CompartmentDefinition.id",
"path" : "CompartmentDefinition.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CompartmentDefinition.meta",
"path" : "CompartmentDefinition.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CompartmentDefinition.implicitRules",
"path" : "CompartmentDefinition.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "CompartmentDefinition.language",
"path" : "CompartmentDefinition.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "CompartmentDefinition.text",
"path" : "CompartmentDefinition.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "CompartmentDefinition.contained",
"path" : "CompartmentDefinition.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CompartmentDefinition.extension",
"path" : "CompartmentDefinition.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CompartmentDefinition.modifierExtension",
"path" : "CompartmentDefinition.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CompartmentDefinition.url",
"path" : "CompartmentDefinition.url",
"short" : "Canonical identifier for this compartment definition, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this compartment definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the compartment definition is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the compartment definition to be referenced by a single globally unique identifier.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CompartmentDefinition.url",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "CompartmentDefinition.version",
"path" : "CompartmentDefinition.version",
"short" : "Business version of the compartment definition",
"definition" : "The identifier that is used to identify this version of the compartment definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the compartment definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different compartment definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the compartment definition with the format [url]|[version].",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CompartmentDefinition.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "CompartmentDefinition.name",
"path" : "CompartmentDefinition.name",
"short" : "Name for this compartment definition (computer friendly)",
"definition" : "A natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.This is often the same as the code for the parameter, but does not need to be.",
"requirements" : "Support human navigation and code generation.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CompartmentDefinition.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CompartmentDefinition.status",
"path" : "CompartmentDefinition.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this compartment definition. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of compartment definitions that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CompartmentDefinition.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "CompartmentDefinition.experimental",
"path" : "CompartmentDefinition.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of compartment definitions that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level compartment definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CompartmentDefinition.experimental",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "CompartmentDefinition.date",
"path" : "CompartmentDefinition.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the compartment definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the compartment definition changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the compartment definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "CompartmentDefinition.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "CompartmentDefinition.publisher",
"path" : "CompartmentDefinition.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the compartment definition.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the compartment definition is the organization or individual primarily responsible for the maintenance and upkeep of the compartment definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the compartment definition. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the compartment definition. May also allow for contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CompartmentDefinition.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "CompartmentDefinition.contact",
"path" : "CompartmentDefinition.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CompartmentDefinition.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "CompartmentDefinition.description",
"path" : "CompartmentDefinition.description",
"short" : "Natural language description of the compartment definition",
"definition" : "A free text natural language description of the compartment definition from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the compartment definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the compartment definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the compartment definition is presumed to be the predominant language in the place the compartment definition was created).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CompartmentDefinition.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "CompartmentDefinition.useContext",
"path" : "CompartmentDefinition.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate compartment definition instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CompartmentDefinition.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "CompartmentDefinition.purpose",
"path" : "CompartmentDefinition.purpose",
"short" : "Why this compartment definition is defined",
"definition" : "Explanation of why this compartment definition is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the compartment definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this compartment definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CompartmentDefinition.purpose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "CompartmentDefinition.code",
"path" : "CompartmentDefinition.code",
"short" : "Patient | Encounter | RelatedPerson | Practitioner | Device",
"definition" : "Which compartment this definition describes.",
"comment" : "Only the specification can define the compartments that can exist. Servers can choose to support them.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CompartmentDefinition.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CompartmentType"
}],
"strength" : "required",
"description" : "Which type a compartment definition describes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/compartment-type|4.0.0"
}
},
{
"id" : "CompartmentDefinition.search",
"path" : "CompartmentDefinition.search",
"short" : "Whether the search syntax is supported",
"definition" : "Whether the search syntax is supported,.",
"comment" : "Servers may define and use compartments to manage logical access without implementing the compartment related syntax.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CompartmentDefinition.search",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CompartmentDefinition.resource",
"path" : "CompartmentDefinition.resource",
"short" : "How a resource is related to the compartment",
"definition" : "Information about how a resource is related to the compartment.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CompartmentDefinition.resource",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CompartmentDefinition.resource.id",
"path" : "CompartmentDefinition.resource.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CompartmentDefinition.resource.extension",
"path" : "CompartmentDefinition.resource.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CompartmentDefinition.resource.modifierExtension",
"path" : "CompartmentDefinition.resource.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CompartmentDefinition.resource.code",
"path" : "CompartmentDefinition.resource.code",
"short" : "Name of resource type",
"definition" : "The name of a resource supported by the server.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CompartmentDefinition.resource.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResourceType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "One of the resource types defined as part of this version of FHIR.",
"valueSet" : "http://hl7.org/fhir/ValueSet/resource-types|4.0.0"
}
},
{
"id" : "CompartmentDefinition.resource.param",
"path" : "CompartmentDefinition.resource.param",
"short" : "Search Parameter Name, or chained parameters",
"definition" : "The name of a search parameter that represents the link to the compartment. More than one may be listed because a resource may be linked to a compartment in more than one way,.",
"comment" : "If no search parameters are listed, then the resource is not linked to the compartment.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CompartmentDefinition.resource.param",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CompartmentDefinition.resource.documentation",
"path" : "CompartmentDefinition.resource.documentation",
"short" : "Additional documentation about the resource and compartment",
"definition" : "Additional documentation about the resource and compartment.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CompartmentDefinition.resource.documentation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "CompartmentDefinition",
"path" : "CompartmentDefinition",
"short" : "Compartment Definition for a resource",
"definition" : "A compartment definition that defines how resources are accessed on a server.",
"comment" : "In FHIR, search is not performed directly on a resource (by XML or JSON path), but on a named parameter that maps into the resource content.",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "cpd-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"mapping" : [{
"identity" : "v2",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CompartmentDefinition.url",
"path" : "CompartmentDefinition.url",
"short" : "Canonical identifier for this compartment definition, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this compartment definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the compartment definition is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the compartment definition to be referenced by a single globally unique identifier.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "CompartmentDefinition.version",
"path" : "CompartmentDefinition.version",
"short" : "Business version of the compartment definition",
"definition" : "The identifier that is used to identify this version of the compartment definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the compartment definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different compartment definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the compartment definition with the format [url]|[version].",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "CompartmentDefinition.name",
"path" : "CompartmentDefinition.name",
"short" : "Name for this compartment definition (computer friendly)",
"definition" : "A natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.This is often the same as the code for the parameter, but does not need to be.",
"requirements" : "Support human navigation and code generation.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isSummary" : true
},
{
"id" : "CompartmentDefinition.status",
"path" : "CompartmentDefinition.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this compartment definition. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of compartment definitions that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "CompartmentDefinition.experimental",
"path" : "CompartmentDefinition.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of compartment definitions that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level compartment definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "CompartmentDefinition.date",
"path" : "CompartmentDefinition.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the compartment definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the compartment definition changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the compartment definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "CompartmentDefinition.publisher",
"path" : "CompartmentDefinition.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the compartment definition.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the compartment definition is the organization or individual primarily responsible for the maintenance and upkeep of the compartment definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the compartment definition. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the compartment definition. May also allow for contact.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "CompartmentDefinition.contact",
"path" : "CompartmentDefinition.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "CompartmentDefinition.description",
"path" : "CompartmentDefinition.description",
"short" : "Natural language description of the compartment definition",
"definition" : "A free text natural language description of the compartment definition from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the compartment definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the compartment definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the compartment definition is presumed to be the predominant language in the place the compartment definition was created).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "CompartmentDefinition.useContext",
"path" : "CompartmentDefinition.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate compartment definition instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "CompartmentDefinition.purpose",
"path" : "CompartmentDefinition.purpose",
"short" : "Why this compartment definition is defined",
"definition" : "Explanation of why this compartment definition is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the compartment definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this compartment definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "CompartmentDefinition.code",
"path" : "CompartmentDefinition.code",
"short" : "Patient | Encounter | RelatedPerson | Practitioner | Device",
"definition" : "Which compartment this definition describes.",
"comment" : "Only the specification can define the compartments that can exist. Servers can choose to support them.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CompartmentType"
}],
"strength" : "required",
"description" : "Which type a compartment definition describes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/compartment-type|4.0.0"
}
},
{
"id" : "CompartmentDefinition.search",
"path" : "CompartmentDefinition.search",
"short" : "Whether the search syntax is supported",
"definition" : "Whether the search syntax is supported,.",
"comment" : "Servers may define and use compartments to manage logical access without implementing the compartment related syntax.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true
},
{
"id" : "CompartmentDefinition.resource",
"path" : "CompartmentDefinition.resource",
"short" : "How a resource is related to the compartment",
"definition" : "Information about how a resource is related to the compartment.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "CompartmentDefinition.resource.code",
"path" : "CompartmentDefinition.resource.code",
"short" : "Name of resource type",
"definition" : "The name of a resource supported by the server.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResourceType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "One of the resource types defined as part of this version of FHIR.",
"valueSet" : "http://hl7.org/fhir/ValueSet/resource-types|4.0.0"
}
},
{
"id" : "CompartmentDefinition.resource.param",
"path" : "CompartmentDefinition.resource.param",
"short" : "Search Parameter Name, or chained parameters",
"definition" : "The name of a search parameter that represents the link to the compartment. More than one may be listed because a resource may be linked to a compartment in more than one way,.",
"comment" : "If no search parameters are listed, then the resource is not linked to the compartment.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "CompartmentDefinition.resource.documentation",
"path" : "CompartmentDefinition.resource.documentation",
"short" : "Additional documentation about the resource and compartment",
"definition" : "Additional documentation about the resource and compartment.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/Composition",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "Composition",
"meta" : {
"lastUpdated" : "2018-12-27T22:37:54.724+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints Composition TU DomainResource A set of resources composed into a single coherent clinical statement with clinical attestation
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension \r\n identifier Σ 0..1 Identifier Version-independent identifier for the Composition \r\n status ?!Σ 1..1 code preliminary | final | amended | entered-in-error
CompositionStatus (Required) \r\n type Σ 1..1 CodeableConcept Kind of composition (LOINC if possible)
FHIR Document Type Codes (Preferred) \r\n category Σ 0..* CodeableConcept Categorization of Composition
Document Class Value Set (Example)
\r\n subject Σ 0..1 Reference(Any) Who and/or what the composition is about \r\n encounter Σ 0..1 Reference(Encounter) Context of the Composition \r\n date Σ 1..1 dateTime Composition editing time \r\n author Σ 1..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the composition
\r\n title Σ 1..1 string Human Readable name/title \r\n confidentiality Σ 0..1 code As defined by affinity domain
V3 Value SetConfidentialityClassification (Required) \r\n attester 0..* BackboneElement Attests to accuracy of composition
\r\n mode 1..1 code personal | professional | legal | official
CompositionAttestationMode (Required) \r\n time 0..1 dateTime When the composition was attested \r\n party 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) Who attested the composition \r\n custodian Σ 0..1 Reference(Organization) Organization which maintains the composition \r\n relatesTo 0..* BackboneElement Relationships to other compositions/documents
\r\n code 1..1 code replaces | transforms | signs | appends
DocumentRelationshipType (Required) \r\n target[x] 1..1 Target of the relationship \r\n targetIdentifier Identifier \r\n targetReference Reference(Composition) \r\n event Σ 0..* BackboneElement The clinical service(s) being documented
\r\n code Σ 0..* CodeableConcept Code(s) that apply to the event being documented
v3 Code System ActCode (Example)
\r\n period Σ 0..1 Period The period covered by the documentation \r\n detail Σ 0..* Reference(Any) The event(s) being documented
\r\n section I 0..* BackboneElement Composition is broken into sections
+ Rule: A section must contain at least one of text, entries, or sub-sections
+ Rule: A section can only have an emptyReason if it is empty
\r\n title 0..1 string Label for section (e.g. for ToC) \r\n code 0..1 CodeableConcept Classification of section (recommended)
Document Section Codes (Example) \r\n author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
\r\n focus 0..1 Reference(Any) Who/what the section is about, when it is not about the subject of composition \r\n text I 0..1 Narrative Text summary of the section, for human interpretation \r\n mode 0..1 code working | snapshot | changes
ListMode (Required) \r\n orderedBy 0..1 CodeableConcept Order of section entries
List Order Codes (Preferred) \r\n entry I 0..* Reference(Any) A reference to data that supports this section
\r\n emptyReason I 0..1 CodeableConcept Why the section is empty
List Empty Reasons (Preferred) \r\n section I 0..* see section Nested Section
\r\n
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Documents"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "not-classified"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "sd"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Composition",
"version" : "4.0.0",
"name" : "Composition",
"status" : "draft",
"date" : "2018-12-27T22:37:54+11:00",
"publisher" : "Health Level Seven International (Structured Documents)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/structure/index.cfm"
}]
}],
"description" : "A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).",
"purpose" : "To support documents, and also to capture the EN13606 notion of an attested commit to the patient EHR, and to allow a set of disparate resources at the information/engineering level to be gathered into a clinical statement.",
"fhirVersion" : "4.0.0",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "cda",
"uri" : "http://hl7.org/v3/cda",
"name" : "CDA (R2)"
},
{
"identity" : "fhirdocumentreference",
"uri" : "http://hl7.org/fhir/documentreference",
"name" : "FHIR DocumentReference"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Composition",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Composition",
"path" : "Composition",
"short" : "A set of resources composed into a single coherent clinical statement with clinical attestation",
"definition" : "A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).",
"comment" : "While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Composition",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "rim",
"map" : "Document[classCode=\"DOC\" and moodCode=\"EVN\" and isNormalAct()]"
},
{
"identity" : "cda",
"map" : "ClinicalDocument"
},
{
"identity" : "fhirdocumentreference",
"map" : "when described by DocumentReference"
}]
},
{
"id" : "Composition.id",
"path" : "Composition.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Composition.meta",
"path" : "Composition.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Composition.implicitRules",
"path" : "Composition.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Composition.language",
"path" : "Composition.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Composition.text",
"path" : "Composition.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Composition.contained",
"path" : "Composition.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Composition.extension",
"path" : "Composition.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Composition.modifierExtension",
"path" : "Composition.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Composition.identifier",
"path" : "Composition.identifier",
"short" : "Version-independent identifier for the Composition",
"definition" : "A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.",
"comment" : "Similar to ClinicalDocument/setId in CDA. See discussion in resource definition for how these relate.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Composition.identifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : "Document.id / Document.setId"
},
{
"identity" : "cda",
"map" : ".setId"
},
{
"identity" : "fhirdocumentreference",
"map" : "DocumentReference.masterIdentifier"
}]
},
{
"id" : "Composition.status",
"path" : "Composition.status",
"short" : "preliminary | final | amended | entered-in-error",
"definition" : "The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.",
"comment" : "If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag \"entered-in-error\" is why this element is labeled as a modifier of other elements. \n\nSome reporting work flows require that the original narrative of a final document never be altered; instead, only new narrative can be added. The composition resource has no explicit status for explicitly noting whether this business rule is in effect. This would be handled by an extension if required.",
"requirements" : "Need to be able to mark interim, amended, or withdrawn compositions or documents.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Composition.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CompositionStatus"
}],
"strength" : "required",
"description" : "The workflow/clinical status of the composition.",
"valueSet" : "http://hl7.org/fhir/ValueSet/composition-status|4.0.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : "interim: .completionCode=\"IN\" & ./statusCode[isNormalDatatype()]=\"active\"; final: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and not(./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseComposition\", code) and isNormalAct()]); amended: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and ./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseComposition\", code) and isNormalAct() and statusCode=\"completed\"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]=\"obsolete\""
},
{
"identity" : "cda",
"map" : "n/a"
},
{
"identity" : "fhirdocumentreference",
"map" : "DocumentReference.status"
}]
},
{
"id" : "Composition.type",
"path" : "Composition.type",
"short" : "Kind of composition (LOINC if possible)",
"definition" : "Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.",
"comment" : "For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding.",
"requirements" : "Key metadata element describing the composition, used in searching/filtering.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Composition.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DocumentType"
}],
"strength" : "preferred",
"description" : "Type of a composition.",
"valueSet" : "http://hl7.org/fhir/ValueSet/doc-typecodes"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : "./code"
},
{
"identity" : "cda",
"map" : ".code"
},
{
"identity" : "fhirdocumentreference",
"map" : "DocumentReference.type"
}]
},
{
"id" : "Composition.category",
"path" : "Composition.category",
"short" : "Categorization of Composition",
"definition" : "A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.",
"comment" : "This is a metadata field from [XDS/MHD](http://wiki.ihe.net/index.php?title=Mobile_access_to_Health_Documents_(MHD)).",
"requirements" : "Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Composition.category",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DocumentCategory"
}],
"strength" : "example",
"description" : "High-level kind of a clinical document at a macro level.",
"valueSet" : "http://hl7.org/fhir/ValueSet/document-classcodes"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"
},
{
"identity" : "cda",
"map" : "n/a"
},
{
"identity" : "fhirdocumentreference",
"map" : "DocumenttReference.category"
}]
},
{
"id" : "Composition.subject",
"path" : "Composition.subject",
"short" : "Who and/or what the composition is about",
"definition" : "Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).",
"comment" : "For clinical documents, this is usually the patient.",
"requirements" : "Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Composition.subject",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=\"SBJ\"].role[typeCode=\"PAT\"]"
},
{
"identity" : "cda",
"map" : ".recordTarget"
},
{
"identity" : "fhirdocumentreference",
"map" : "DocumentReference.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Composition.encounter",
"path" : "Composition.encounter",
"short" : "Context of the Composition",
"definition" : "Describes the clinical encounter or type of care this documentation is associated with.",
"requirements" : "Provides context for the composition and supports searching.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Composition.encounter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.context"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : "unique(highest(./outboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()], priorityNumber)/target[moodCode=\"EVN\" and classCode=(\"ENC\", \"PCPR\") and isNormalAct])"
},
{
"identity" : "cda",
"map" : ".componentOf.encompassingEncounter"
},
{
"identity" : "fhirdocumentreference",
"map" : "DocumentReference.context.encounter"
}]
},
{
"id" : "Composition.date",
"path" : "Composition.date",
"short" : "Composition editing time",
"definition" : "The composition editing time, when the composition was last logically changed by the author.",
"comment" : "The Last Modified Date on the composition may be after the date of the document was attested without being changed.",
"requirements" : "dateTime is used for tracking, organizing versions and searching. Note that this is the time of *authoring*. When packaged in a document, [Bundle.timestamp](bundle-definitions.html#Bundle.timestamp) is the date of packaging.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Composition.date",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "rim",
"map" : ".effectiveTime[type=\"TS\"]"
},
{
"identity" : "cda",
"map" : ".effectiveTime"
},
{
"identity" : "fhirdocumentreference",
"map" : "DocumentReference.content.attachment.date, DocumentReference.created"
}]
},
{
"id" : "Composition.author",
"path" : "Composition.author",
"short" : "Who and/or what authored the composition",
"definition" : "Identifies who is responsible for the information in the composition, not necessarily who typed it in.",
"requirements" : "Identifies who is responsible for the content.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Composition.author",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]"
},
{
"identity" : "cda",
"map" : ".author.assignedAuthor"
},
{
"identity" : "fhirdocumentreference",
"map" : "DocumentReference.agent"
}]
},
{
"id" : "Composition.title",
"path" : "Composition.title",
"short" : "Human Readable name/title",
"definition" : "Official human-readable label for the composition.",
"comment" : "For many compositions, the title is the same as the text or a display name of Composition.type (e.g. a \"consultation\" or \"progress note\"). Note that CDA does not make title mandatory, but there are no known cases where it is useful for title to be omitted, so it is mandatory here. Feedback on this requirement is welcome during the trial use period.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Composition.title",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "./title"
},
{
"identity" : "cda",
"map" : ".title"
},
{
"identity" : "fhirdocumentreference",
"map" : "DocumentReference.description, DocumentReference.content.attachment.title"
}]
},
{
"id" : "Composition.confidentiality",
"path" : "Composition.confidentiality",
"short" : "As defined by affinity domain",
"definition" : "The code specifying the level of confidentiality of the Composition.",
"comment" : "The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section). This element is labeled as a modifier because highly confidential documents must not be treated as if they are not.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Composition.confidentiality",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DocumentConfidentiality"
}],
"strength" : "required",
"description" : "Codes specifying the level of confidentiality of the composition.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|4.0.0"
},
"mapping" : [{
"identity" : "rim",
"map" : ".confidentialityCode"
},
{
"identity" : "cda",
"map" : ".confidentialityCode"
},
{
"identity" : "fhirdocumentreference",
"map" : "DocumentReference.securityLabel"
}]
},
{
"id" : "Composition.attester",
"path" : "Composition.attester",
"short" : "Attests to accuracy of composition",
"definition" : "A participant who has attested to the accuracy of the composition/document.",
"comment" : "Only list each attester once.",
"requirements" : "Identifies responsibility for the accuracy of the composition content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Composition.attester",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=\"AUTHEN\"].role[classCode=\"ASSIGNED\"]"
},
{
"identity" : "cda",
"map" : ".authenticator/.legalAuthenticator"
},
{
"identity" : "fhirdocumentreference",
"map" : "DocumentReference.authenticator"
}]
},
{
"id" : "Composition.attester.id",
"path" : "Composition.attester.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Composition.attester.extension",
"path" : "Composition.attester.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Composition.attester.modifierExtension",
"path" : "Composition.attester.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Composition.attester.mode",
"path" : "Composition.attester.mode",
"short" : "personal | professional | legal | official",
"definition" : "The type of attestation the authenticator offers.",
"requirements" : "Indicates the level of authority of the attestation.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Composition.attester.mode",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CompositionAttestationMode"
}],
"strength" : "required",
"description" : "The way in which a person authenticated a composition.",
"valueSet" : "http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.0"
},
"mapping" : [{
"identity" : "rim",
"map" : "unique(./modeCode)"
},
{
"identity" : "cda",
"map" : "implied by .authenticator/.legalAuthenticator"
}]
},
{
"id" : "Composition.attester.time",
"path" : "Composition.attester.time",
"short" : "When the composition was attested",
"definition" : "When the composition was attested by the party.",
"requirements" : "Identifies when the information in the composition was deemed accurate. (Things may have changed since then.).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Composition.attester.time",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "./time[type=\"TS\" and isNormalDatatype()]"
},
{
"identity" : "cda",
"map" : ".authenticator.time"
}]
},
{
"id" : "Composition.attester.party",
"path" : "Composition.attester.party",
"short" : "Who attested the composition",
"definition" : "Who attested the composition in the specified way.",
"requirements" : "Identifies who has taken on the responsibility for accuracy of the composition content.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Composition.attester.party",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.witness"
},
{
"identity" : "rim",
"map" : "./role[classCode=\"ASSIGNED\" and isNormalRole]/player[determinerCode=\"INST\" and classCode=(\"DEV\", \"PSN\") and isNormalEntity()] or ./role[classCode=\"ASSIGNED\" and isNormalRole and not(player)]/scoper[determinerCode=\"INST\" and classCode=\"ORG\" and isNormalEntity()]"
},
{
"identity" : "cda",
"map" : ".authenticator.assignedEnttty"
}]
},
{
"id" : "Composition.custodian",
"path" : "Composition.custodian",
"short" : "Organization which maintains the composition",
"definition" : "Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.",
"comment" : "This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because this is sometimes not known by the authoring system, and can be inferred by context. However, it is important that this information be known when working with a derived document, so providing a custodian is encouraged.",
"requirements" : "Identifies where to go to find the current version, where to report issues, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Composition.custodian",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=\"RCV\"].role[classCode=\"CUST\"].scoper[classCode=\"ORG\" and determinerCode=\"INST\"]"
},
{
"identity" : "cda",
"map" : ".custodian.assignedCustodian"
},
{
"identity" : "fhirdocumentreference",
"map" : "DocumentReference.custodian"
}]
},
{
"id" : "Composition.relatesTo",
"path" : "Composition.relatesTo",
"short" : "Relationships to other compositions/documents",
"definition" : "Relationships that this composition has with other compositions or documents that already exist.",
"comment" : "A document is a version specific composition.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Composition.relatesTo",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship"
},
{
"identity" : "cda",
"map" : ".relatedDocument"
},
{
"identity" : "fhirdocumentreference",
"map" : "DocumentReference.relatesTo"
}]
},
{
"id" : "Composition.relatesTo.id",
"path" : "Composition.relatesTo.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Composition.relatesTo.extension",
"path" : "Composition.relatesTo.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Composition.relatesTo.modifierExtension",
"path" : "Composition.relatesTo.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Composition.relatesTo.code",
"path" : "Composition.relatesTo.code",
"short" : "replaces | transforms | signs | appends",
"definition" : "The type of relationship that this composition has with anther composition or document.",
"comment" : "If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Composition.relatesTo.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DocumentRelationshipType"
}],
"strength" : "required",
"description" : "The type of relationship between documents.",
"valueSet" : "http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.0"
},
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship.typeCode"
},
{
"identity" : "cda",
"map" : ".relatedDocument.typeCode"
},
{
"identity" : "fhirdocumentreference",
"map" : "DocumentReference.relatesTo.code"
}]
},
{
"id" : "Composition.relatesTo.target[x]",
"path" : "Composition.relatesTo.target[x]",
"short" : "Target of the relationship",
"definition" : "The target composition/document of this relationship.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Composition.relatesTo.target[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Composition"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".target[classCode=\"DOC\", moodCode=\"EVN\"].id"
},
{
"identity" : "cda",
"map" : ".relatedDocument.id"
},
{
"identity" : "fhirdocumentreference",
"map" : "DocumentReference.relatesTo.target"
}]
},
{
"id" : "Composition.event",
"path" : "Composition.event",
"short" : "The clinical service(s) being documented",
"definition" : "The clinical service, such as a colonoscopy or an appendectomy, being documented.",
"comment" : "The event needs to be consistent with the type element, though can provide further information if desired.",
"requirements" : "Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Composition.event",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "outboundRelationship[typeCode=\"SUBJ\"].target[classCode<'ACT']"
},
{
"identity" : "cda",
"map" : ".documentationOf.serviceEvent"
},
{
"identity" : "fhirdocumentreference",
"map" : "DocumentReference.event"
}]
},
{
"id" : "Composition.event.id",
"path" : "Composition.event.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Composition.event.extension",
"path" : "Composition.event.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Composition.event.modifierExtension",
"path" : "Composition.event.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Composition.event.code",
"path" : "Composition.event.code",
"short" : "Code(s) that apply to the event being documented",
"definition" : "This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act.",
"comment" : "An event can further specialize the act inherent in the typeCode, such as where it is simply \"Procedure Report\" and the procedure was a \"colonoscopy\". If one or more eventCodes are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as key words for certain types of queries.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Composition.event.code",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DocumentEventType"
}],
"strength" : "example",
"description" : "This list of codes represents the main clinical acts being documented.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActCode"
},
"mapping" : [{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "cda",
"map" : ".code"
},
{
"identity" : "fhirdocumentreference",
"map" : "DocumentReference.event.code"
}]
},
{
"id" : "Composition.event.period",
"path" : "Composition.event.period",
"short" : "The period covered by the documentation",
"definition" : "The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Composition.event.period",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".effectiveTime"
},
{
"identity" : "cda",
"map" : ".effectiveTime"
},
{
"identity" : "fhirdocumentreference",
"map" : "DocumentReference.event.period"
}]
},
{
"id" : "Composition.event.detail",
"path" : "Composition.event.detail",
"short" : "The event(s) being documented",
"definition" : "The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Composition.event.detail",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"SUBJ\"].target"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Composition.section",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Section"
}],
"path" : "Composition.section",
"short" : "Composition is broken into sections",
"definition" : "The root of the sections that make up the composition.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Composition.section",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "cmp-1",
"severity" : "error",
"human" : "A section must contain at least one of text, entries, or sub-sections",
"expression" : "text.exists() or entry.exists() or section.exists()",
"xpath" : "exists(f:text) or exists(f:entry) or exists(f:section)"
},
{
"key" : "cmp-2",
"severity" : "error",
"human" : "A section can only have an emptyReason if it is empty",
"expression" : "emptyReason.empty() or entry.empty()",
"xpath" : "not(exists(f:emptyReason) and exists(f:entry))"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]"
},
{
"identity" : "cda",
"map" : ".component.structuredBody.component.section"
}]
},
{
"id" : "Composition.section.id",
"path" : "Composition.section.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Composition.section.extension",
"path" : "Composition.section.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Composition.section.modifierExtension",
"path" : "Composition.section.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Composition.section.title",
"path" : "Composition.section.title",
"short" : "Label for section (e.g. for ToC)",
"definition" : "The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.",
"comment" : "The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.",
"requirements" : "Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.",
"alias" : ["header",
"label",
"caption"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Composition.section.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "./title"
},
{
"identity" : "cda",
"map" : ".title"
}]
},
{
"id" : "Composition.section.code",
"path" : "Composition.section.code",
"short" : "Classification of section (recommended)",
"definition" : "A code identifying the kind of content contained within the section. This must be consistent with the section title.",
"comment" : "The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. \n\nIf the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.",
"requirements" : "Provides computable standardized labels to topics within the document.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Composition.section.code",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CompositionSectionType"
}],
"strength" : "example",
"description" : "Classification of a section of a composition/document.",
"valueSet" : "http://hl7.org/fhir/ValueSet/doc-section-codes"
},
"mapping" : [{
"identity" : "rim",
"map" : "./code"
},
{
"identity" : "cda",
"map" : ".code"
}]
},
{
"id" : "Composition.section.author",
"path" : "Composition.section.author",
"short" : "Who and/or what authored the section",
"definition" : "Identifies who is responsible for the information in this section, not necessarily who typed it in.",
"requirements" : "Identifies who is responsible for the content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Composition.section.author",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]"
},
{
"identity" : "cda",
"map" : ".author.assignedAuthor"
}]
},
{
"id" : "Composition.section.focus",
"path" : "Composition.section.focus",
"short" : "Who/what the section is about, when it is not about the subject of composition",
"definition" : "The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).",
"comment" : "Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Composition.section.focus",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "cda",
"map" : ".subject? (CDA did not differentiate between subject and focus)"
}]
},
{
"id" : "Composition.section.text",
"path" : "Composition.section.text",
"short" : "Text summary of the section, for human interpretation",
"definition" : "A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative.",
"comment" : "Document profiles may define what content should be represented in the narrative to ensure clinical safety.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Composition.section.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"condition" : ["cmp-1"],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".text"
},
{
"identity" : "cda",
"map" : ".text"
}]
},
{
"id" : "Composition.section.mode",
"path" : "Composition.section.mode",
"short" : "working | snapshot | changes",
"definition" : "How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.",
"comment" : "This element is labeled as a modifier because a change list must not be misunderstood as a complete list.",
"requirements" : "Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Composition.section.mode",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SectionMode"
}],
"strength" : "required",
"description" : "The processing mode that applies to this section.",
"valueSet" : "http://hl7.org/fhir/ValueSet/list-mode|4.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Composition.section.orderedBy",
"path" : "Composition.section.orderedBy",
"short" : "Order of section entries",
"definition" : "Specifies the order applied to the items in the section entries.",
"comment" : "Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.",
"requirements" : "Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Composition.section.orderedBy",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SectionEntryOrder"
}],
"strength" : "preferred",
"description" : "What order applies to the items in the entry.",
"valueSet" : "http://hl7.org/fhir/ValueSet/list-order"
},
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].sequenceNumber > 1"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Composition.section.entry",
"path" : "Composition.section.entry",
"short" : "A reference to data that supports this section",
"definition" : "A reference to the actual resource from which the narrative in the section is derived.",
"comment" : "If there are no entries in the list, an emptyReason SHOULD be provided.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Composition.section.entry",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"condition" : ["cmp-2"],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]"
},
{
"identity" : "cda",
"map" : ".entry"
}]
},
{
"id" : "Composition.section.emptyReason",
"path" : "Composition.section.emptyReason",
"short" : "Why the section is empty",
"definition" : "If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.",
"comment" : "The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.",
"requirements" : "Allows capturing things like \"none exist\" or \"not asked\" which can be important for most lists.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Composition.section.emptyReason",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"condition" : ["cmp-2"],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SectionEmptyReason"
}],
"strength" : "preferred",
"description" : "If a section is empty, why it is empty.",
"valueSet" : "http://hl7.org/fhir/ValueSet/list-empty-reason"
},
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ,code 1"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Composition.section.entry",
"path" : "Composition.section.entry",
"short" : "A reference to data that supports this section",
"definition" : "A reference to the actual resource from which the narrative in the section is derived.",
"comment" : "If there are no entries in the list, an emptyReason SHOULD be provided.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"condition" : ["cmp-2"],
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]"
},
{
"identity" : "cda",
"map" : ".entry"
}]
},
{
"id" : "Composition.section.emptyReason",
"path" : "Composition.section.emptyReason",
"short" : "Why the section is empty",
"definition" : "If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.",
"comment" : "The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.",
"requirements" : "Allows capturing things like \"none exist\" or \"not asked\" which can be important for most lists.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"condition" : ["cmp-2"],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SectionEmptyReason"
}],
"strength" : "preferred",
"description" : "If a section is empty, why it is empty.",
"valueSet" : "http://hl7.org/fhir/ValueSet/list-empty-reason"
},
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ,codeName Flags Card. Type Description & Constraints ConceptMap ITU DomainResource A map from one set of concepts to one or more other concepts
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension \r\n url Σ 0..1 uri Canonical identifier for this concept map, represented as a URI (globally unique) \r\n identifier Σ 0..1 Identifier Additional identifier for the concept map \r\n version Σ 0..1 string Business version of the concept map \r\n name ΣI 0..1 string Name for this concept map (computer friendly) \r\n title Σ 0..1 string Name for this concept map (human friendly) \r\n status ?!Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required) \r\n experimental Σ 0..1 boolean For testing purposes, not real usage \r\n date Σ 0..1 dateTime Date last changed \r\n publisher Σ 0..1 string Name of the publisher (organization or individual) \r\n contact Σ 0..* ContactDetail Contact details for the publisher
\r\n description 0..1 markdown Natural language description of the concept map \r\n useContext Σ 0..* UsageContext The context that the content is intended to support
\r\n jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for concept map (if applicable)
Jurisdiction (Extensible)
\r\n purpose 0..1 markdown Why this concept map is defined \r\n copyright 0..1 markdown Use and/or publishing restrictions \r\n source[x] Σ 0..1 The source value set that contains the concepts that are being mapped \r\n sourceUri uri \r\n sourceCanonical canonical(ValueSet) \r\n target[x] Σ 0..1 The target value set which provides context for the mappings \r\n targetUri uri \r\n targetCanonical canonical(ValueSet) \r\n group 0..* BackboneElement Same source and target systems
\r\n source 0..1 uri Source system where concepts to be mapped are defined \r\n sourceVersion 0..1 string Specific version of the code system \r\n target 0..1 uri Target system that the concepts are to be mapped to \r\n targetVersion 0..1 string Specific version of the code system \r\n element 1..* BackboneElement Mappings for a concept from the source set
\r\n code 0..1 code Identifies element being mapped \r\n display 0..1 string Display for the code \r\n target I 0..* BackboneElement Concept in target system for element
+ Rule: If the map is narrower or inexact, there SHALL be some comments
\r\n code 0..1 code Code that identifies the target element \r\n display 0..1 string Display for the code \r\n equivalence ?! 1..1 code relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
ConceptMapEquivalence (Required) \r\n comment I 0..1 string Description of status/issues in mapping \r\n dependsOn 0..* BackboneElement Other elements required for this mapping (from context)
\r\n property 1..1 uri Reference to property mapping depends on \r\n system 0..1 canonical(CodeSystem) Code System (if necessary) \r\n value 1..1 string Value of the referenced element \r\n display 0..1 string Display for the code (if value is a code) \r\n product 0..* see dependsOn Other concepts that this mapping also produces
\r\n unmapped I 0..1 BackboneElement What to do when there is no mapping for the source concept
+ Rule: If the mode is 'fixed', a code must be provided
+ Rule: If the mode is 'other-map', a url must be provided \r\n mode 1..1 code provided | fixed | other-map
ConceptMapGroupUnmappedMode (Required) \r\n code 0..1 code Fixed code when mode = fixed \r\n display 0..1 string Display for the code \r\n url 0..1 canonical(ConceptMap) canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped \r\n
Documentation for this format