This page is part of the FHIR Specification (v5.0.0-snapshot1: Release 5 Snapshot #1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
. Page versions: R4B R4
| FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative |
Raw JSON (canonical form + also see JSON Format Specification)
episodeOfCare
{
"resourceType" : "StructureDefinition",
"id" : "workflow-episodeOfCare",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
}],
"url" : "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare",
"version" : "5.0.0-snapshot1",
"name" : "episodeOfCare",
"title" : "Episode of Care",
"status" : "draft",
"date" : "2017-12-06",
"publisher" : "Health Level Seven, Inc. - FHIR WG",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/special/committees/fwg"
}]
}],
"description" : "Identifies the episode(s) of care that this resource is relevant to. Establishes the EpisodeOfCare as a 'grouper' of resources that are relevant to that episode.",
"fhirVersion" : "5.0.0-snapshot1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "complex-type",
"abstract" : false,
"context" : [{
"type" : "element",
"expression" : "AdverseEvent"
},
{
"type" : "element",
"expression" : "Appointment"
},
{
"type" : "element",
"expression" : "Basic"
},
{
"type" : "element",
"expression" : "CarePlan"
},
{
"type" : "element",
"expression" : "ClinicalImpression"
},
{
"type" : "element",
"expression" : "Communication"
},
{
"type" : "element",
"expression" : "CommunicationRequest"
},
{
"type" : "element",
"expression" : "Composition"
},
{
"type" : "element",
"expression" : "Condition"
},
{
"type" : "element",
"expression" : "Consent"
},
{
"type" : "element",
"expression" : "DetectedIssue"
},
{
"type" : "element",
"expression" : "DeviceRequest"
},
{
"type" : "element",
"expression" : "DeviceUsage"
},
{
"type" : "element",
"expression" : "DiagnosticReport"
},
{
"type" : "element",
"expression" : "DocumentReference"
},
{
"type" : "element",
"expression" : "Encounter"
},
{
"type" : "element",
"expression" : "EnrollmentRequest"
},
{
"type" : "element",
"expression" : "EnrollmentResponse"
},
{
"type" : "element",
"expression" : "FamilyMemberHistory"
},
{
"type" : "element",
"expression" : "Flag"
},
{
"type" : "element",
"expression" : "Goal"
},
{
"type" : "element",
"expression" : "ImagingStudy"
},
{
"type" : "element",
"expression" : "Immunization"
},
{
"type" : "element",
"expression" : "ImmunizationEvaluation"
},
{
"type" : "element",
"expression" : "ImmunizationRecommendation"
},
{
"type" : "element",
"expression" : "Invoice"
},
{
"type" : "element",
"expression" : "List"
},
{
"type" : "element",
"expression" : "MeasureReport"
},
{
"type" : "element",
"expression" : "MedicationAdministration"
},
{
"type" : "element",
"expression" : "MedicationDispense"
},
{
"type" : "element",
"expression" : "MedicationRequest"
},
{
"type" : "element",
"expression" : "MedicationUsage"
},
{
"type" : "element",
"expression" : "MolecularSequence"
},
{
"type" : "element",
"expression" : "NutritionIntake"
},
{
"type" : "element",
"expression" : "NutritionOrder"
},
{
"type" : "element",
"expression" : "Observation"
},
{
"type" : "element",
"expression" : "Procedure"
},
{
"type" : "element",
"expression" : "QuestionnaireResponse"
},
{
"type" : "element",
"expression" : "RequestGroup"
},
{
"type" : "element",
"expression" : "ResearchSubject"
},
{
"type" : "element",
"expression" : "RiskAssessment"
},
{
"type" : "element",
"expression" : "SupplyDelivery"
},
{
"type" : "element",
"expression" : "SupplyRequest"
},
{
"type" : "element",
"expression" : "VisionPrescription"
},
{
"type" : "element",
"expression" : "ServiceRequest"
}],
"type" : "Extension",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation" : "constraint",
"snapshot" : {
"element" : [{
"id" : "Extension",
"path" : "Extension",
"short" : "Associated Encounter episode of care",
"definition" : "Identifies the episode(s) of care that this resource is relevant to. Establishes the EpisodeOfCare as a 'grouper' of resources that are relevant to that episode.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Extension",
"min" : 0,
"max" : "*"
},
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]"
}]
},
{
"id" : "Extension.id",
"path" : "Extension.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" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Extension.extension",
"path" : "Extension.extension",
"slicing" : {
"discriminator" : [{
"type" : "value",
"path" : "url"
}],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Extension",
"definition" : "An Extension",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Extension.url",
"path" : "Extension.url",
"representation" : ["xmlAttr"],
"short" : "identifies the meaning of the extension",
"definition" : "Source of the definition for the extension code - a logical name or a URL.",
"comment" : "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Extension.url",
"min" : 1,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "uri"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"fixedUri" : "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare",
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Extension.value[x]",
"path" : "Extension.value[x]",
"short" : "Value of extension",
"definition" : "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Extension.value[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"]
}],
"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" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
}]
},
"differential" : {
"element" : [{
"id" : "Extension",
"path" : "Extension",
"short" : "Associated Encounter episode of care",
"definition" : "Identifies the episode(s) of care that this resource is relevant to. Establishes the EpisodeOfCare as a 'grouper' of resources that are relevant to that episode.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]"
}]
},
{
"id" : "Extension.extension",
"path" : "Extension.extension",
"max" : "0"
},
{
"id" : "Extension.url",
"path" : "Extension.url",
"fixedUri" : "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare"
},
{
"id" : "Extension.value[x]",
"path" : "Extension.value[x]",
"min" : 1,
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"]
}]
}]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.