Episodeofcare.profile.json

Profile for episodeofcare

{
  "resourceType": "Profile",
  "id": "EpisodeOfCare",
  "meta": {
    "lastUpdated": "2015-02-23T09:07:27.665+11:00"
  },
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/Profile/EpisodeOfCare",
  "name": "EpisodeOfCare",
  "publisher": "HL7 FHIR Project (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": "Base Profile for EpisodeOfCare Resource",
  "status": "draft",
  "date": "2015-02-23T09:07:27+11:00",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM"
    }
  ],
  "type": "EpisodeOfCare",
  "snapshot": {
    "element": [
      {
        "path": "EpisodeOfCare",
        "short": "An association of a Patient with an Organization and  Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility",
        "definition": "An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.",
        "synonym": [
          "Case Program Problem"
        ],
        "min": 1,
        "max": "1"
      },
      {
        "path": "EpisodeOfCare.id",
        "short": "Logical id of this artefact",
        "definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
        "comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "id"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.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 may not always be associated with version changes to the resource.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Meta"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.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.",
        "comments": "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 as much as possible.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "uri"
          }
        ],
        "isModifier": true
      },
      {
        "path": "EpisodeOfCare.language",
        "short": "Language of the resource content",
        "definition": "The base language in which the resource is written.",
        "comments": "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\n\nNot 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": {
          "name": "Language",
          "isExtensible": false,
          "conformance": "required",
          "description": "A human language",
          "referenceUri": "http://tools.ietf.org/html/bcp47"
        }
      },
      {
        "path": "EpisodeOfCare.text",
        "short": "Text summary of the resource, for human interpretation",
        "definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
        "comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
        "synonym": [
          "narrative",
          "html",
          "xhtml",
          "display"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Narrative"
          }
        ],
        "condition": [
          "dom-1"
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "Act.text?"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.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.",
        "comments": "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.",
        "synonym": [
          "inline resources",
          "anonymous resources",
          "contained resources"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Resource"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.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. In order 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.",
        "comments": "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.",
        "synonym": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.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. Usually modifier elements provide negation or qualification. In order 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.",
        "comments": "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.",
        "synonym": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.identifier",
        "short": "Identifier(s) by which this EpisodeOfCare is known",
        "definition": "Identifier(s) by which this EpisodeOfCare is known.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Identifier"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.currentStatus",
        "short": "planned | active | onhold | finished | withdrawn | other",
        "definition": "planned | active | onhold | finished | withdrawn | other.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "isSummary": true,
        "binding": {
          "name": "EpisodeOfCareStatus",
          "isExtensible": false,
          "conformance": "required",
          "description": "The status of the encounter",
          "referenceReference": {
            "reference": "http://hl7.org/fhir/vs/episode-of-care-status"
          }
        }
      },
      {
        "path": "EpisodeOfCare.statusHistory",
        "short": "The status history for the EpisodeOfCare",
        "definition": "The status history for the EpisodeOfCare.",
        "min": 0,
        "max": "*"
      },
      {
        "path": "EpisodeOfCare.statusHistory.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "xml:id (or equivalent in JSON)",
        "definition": "unique id for the element within a resource (for internal references).",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "id"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.statusHistory.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. In order 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.",
        "comments": "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.",
        "synonym": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.statusHistory.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 element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.",
        "comments": "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.",
        "synonym": [
          "extensions",
          "user content",
          "modifiers"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.statusHistory.status",
        "short": "planned | active | onhold | finished | withdrawn | other",
        "definition": "planned | active | onhold | finished | withdrawn | other.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "name": "EpisodeOfCareStatus",
          "isExtensible": false,
          "conformance": "required",
          "description": "The status of the encounter",
          "referenceReference": {
            "reference": "http://hl7.org/fhir/vs/episode-of-care-status"
          }
        }
      },
      {
        "path": "EpisodeOfCare.statusHistory.period",
        "short": "The period during this episodeofcare that the specific status applied",
        "definition": "The period during this episodeofcare that the specific status applied.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Period"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.type",
        "short": "Specific type of EpisodeOfcare",
        "definition": "The type can be very important in processing as this could be used in determining if the episodeofcare is relevant to specific government reporting, or other types of classifications.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "isSummary": true
      },
      {
        "path": "EpisodeOfCare.patient",
        "short": "The patient that this episodeofcare applies to",
        "definition": "The patient that this episodeofcare applies to.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/Profile/Patient"
          }
        ],
        "isSummary": true
      },
      {
        "path": "EpisodeOfCare.managingOrganization",
        "short": "The organization that has assumed the specific responsibilities for the specified duration",
        "definition": "The organization that has assumed the specific responsibilities for the specified duration.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/Profile/Organization"
          }
        ],
        "isSummary": true
      },
      {
        "path": "EpisodeOfCare.period",
        "short": "The interval during which the managing organization assumes the defined responsibility",
        "definition": "The interval during which the managing organization assumes the defined responsibility.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Period"
          }
        ],
        "isSummary": true
      },
      {
        "path": "EpisodeOfCare.condition",
        "short": "A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for",
        "definition": "A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/Profile/Condition"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.referralRequest",
        "short": "A Referral Request that this EpisodeOfCare manages activities within",
        "definition": "A Referral Request that this EpisodeOfCare manages activities within.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/Profile/ReferralRequest"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.careManager",
        "short": "The practitioner that is the care manager/care co-ordinator for this patient",
        "definition": "The practitioner that is the care manager/care co-ordinator for this patient.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/Profile/Practitioner"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.careTeam",
        "short": "The list of practitioners that may be facilitating this episode of care for specific purposes",
        "definition": "The list of practitioners that may be facilitating this episode of care for specific purposes.",
        "min": 0,
        "max": "*"
      },
      {
        "path": "EpisodeOfCare.careTeam.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "xml:id (or equivalent in JSON)",
        "definition": "unique id for the element within a resource (for internal references).",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "id"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.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. In order 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.",
        "comments": "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.",
        "synonym": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.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 element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.",
        "comments": "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.",
        "synonym": [
          "extensions",
          "user content",
          "modifiers"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.careTeam.member",
        "short": "The practitioner within the team",
        "definition": "The practitioner within the team.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/Profile/Practitioner"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.careTeam.role",
        "short": "The role that this team member is taking within this episode of care",
        "definition": "The role that this team member is taking within this episode of care.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.careTeam.period",
        "short": "The period of time that this practitioner is performing some role within the episode of care",
        "definition": "The period of time that this practitioner is performing some role within the episode of care.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Period"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "path": "EpisodeOfCare",
        "short": "An association of a Patient with an Organization and  Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility",
        "definition": "An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.",
        "synonym": [
          "Case Program Problem"
        ],
        "min": 1,
        "max": "1"
      },
      {
        "path": "EpisodeOfCare.identifier",
        "short": "Identifier(s) by which this EpisodeOfCare is known",
        "definition": "Identifier(s) by which this EpisodeOfCare is known.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Identifier"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.currentStatus",
        "short": "planned | active | onhold | finished | withdrawn | other",
        "definition": "planned | active | onhold | finished | withdrawn | other.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "isSummary": true,
        "binding": {
          "name": "EpisodeOfCareStatus",
          "isExtensible": false,
          "conformance": "required",
          "description": "The status of the encounter",
          "referenceReference": {
            "reference": "http://hl7.org/fhir/vs/episode-of-care-status"
          }
        }
      },
      {
        "path": "EpisodeOfCare.statusHistory",
        "short": "The status history for the EpisodeOfCare",
        "definition": "The status history for the EpisodeOfCare.",
        "min": 0,
        "max": "*"
      },
      {
        "path": "EpisodeOfCare.statusHistory.status",
        "short": "planned | active | onhold | finished | withdrawn | other",
        "definition": "planned | active | onhold | finished | withdrawn | other.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "name": "EpisodeOfCareStatus",
          "isExtensible": false,
          "conformance": "required",
          "description": "The status of the encounter",
          "referenceReference": {
            "reference": "http://hl7.org/fhir/vs/episode-of-care-status"
          }
        }
      },
      {
        "path": "EpisodeOfCare.statusHistory.period",
        "short": "The period during this episodeofcare that the specific status applied",
        "definition": "The period during this episodeofcare that the specific status applied.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Period"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.type",
        "short": "Specific type of EpisodeOfcare",
        "definition": "The type can be very important in processing as this could be used in determining if the episodeofcare is relevant to specific government reporting, or other types of classifications.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "isSummary": true
      },
      {
        "path": "EpisodeOfCare.patient",
        "short": "The patient that this episodeofcare applies to",
        "definition": "The patient that this episodeofcare applies to.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/Profile/Patient"
          }
        ],
        "isSummary": true
      },
      {
        "path": "EpisodeOfCare.managingOrganization",
        "short": "The organization that has assumed the specific responsibilities for the specified duration",
        "definition": "The organization that has assumed the specific responsibilities for the specified duration.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/Profile/Organization"
          }
        ],
        "isSummary": true
      },
      {
        "path": "EpisodeOfCare.period",
        "short": "The interval during which the managing organization assumes the defined responsibility",
        "definition": "The interval during which the managing organization assumes the defined responsibility.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Period"
          }
        ],
        "isSummary": true
      },
      {
        "path": "EpisodeOfCare.condition",
        "short": "A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for",
        "definition": "A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/Profile/Condition"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.referralRequest",
        "short": "A Referral Request that this EpisodeOfCare manages activities within",
        "definition": "A Referral Request that this EpisodeOfCare manages activities within.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/Profile/ReferralRequest"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.careManager",
        "short": "The practitioner that is the care manager/care co-ordinator for this patient",
        "definition": "The practitioner that is the care manager/care co-ordinator for this patient.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/Profile/Practitioner"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.careTeam",
        "short": "The list of practitioners that may be facilitating this episode of care for specific purposes",
        "definition": "The list of practitioners that may be facilitating this episode of care for specific purposes.",
        "min": 0,
        "max": "*"
      },
      {
        "path": "EpisodeOfCare.careTeam.member",
        "short": "The practitioner within the team",
        "definition": "The practitioner within the team.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/Profile/Practitioner"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.careTeam.role",
        "short": "The role that this team member is taking within this episode of care",
        "definition": "The role that this team member is taking within this episode of care.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "path": "EpisodeOfCare.careTeam.period",
        "short": "The period of time that this practitioner is performing some role within the episode of care",
        "definition": "The period of time that this practitioner is performing some role within the episode of care.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Period"
          }
        ]
      }
    ]
  }
}