{ "resourceType": "StructureDefinition", "id": "ocp-flag", "meta": { "versionId": "1", "lastUpdated": "2018-04-27T21:50:50.89+00:00" }, "language": "US-en", "text": { "status": "generated", "div": "
\nThe FHIR STU3 (Release 3) Omnibus Care Plan (OCP) Flag profile uses FHIR resources and describes minimum expectations with supported data elements and changes to the cardinality to alert practitioners to information that is important to influence their interaction with a Omnibus Care Plan (OCP) Patient prior to detailed review of the record. It identifies which core elements, extensions, and value sets SHALL be present in the resource when using this profile. Flags are not raised as a result of a reported or proposed action.\nDependencies:\n Flag profile that conforms to this specification must include reference to other resources \n
" }, "url": "http://hl7.org/fhir/StructureDefinition/ocp-flag", "version": "1.0", "name": "OCP Flag Profile", "title": "OCP Flag Profile", "status": "draft", "date": "2018-03-26T18:59:09.485+00:00", "publisher": "SAMHSA", "contact": [ { "name": "Neelima Chennamaraja", "telecom": [ { "system": "url", "value": "www.eversolve.com", "period": { "start": "1999-06-15" } }, { "system": "email", "value": "neelima@eversolve.com", "use": "work" } ] } ], "description": "The Omnibus Care Plan (OCP) Flag profile is used to alert practitioners to information that is important to influence their interaction with a Omnibus Care Plan (OCP) Patient prior to detailed review of the record. Flags are not used to convey information to a specific individual or organization. Flags are not raised as a result of a reported or proposed action.", "jurisdiction": [ { "coding": [ { "code": "US", "display": "US-Realm" } ], "text": "US-Realm OCP Flag Profile published by SAMHSA" } ], "purpose": "The OCP Flag profile includes all the elements related to basic need for OCP (which could change over time). This profile is intended to be implemented by OCP (Omnibus Care Plan) systems.", "copyright": "+Copyright (c) 2017 SAMHSA. All Rights Reserved.", "fhirVersion": "3.0.1", "kind": "resource", "abstract": false, "type": "Flag", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Flag", "derivation": "constraint", "snapshot": { "element": [ { "id": "Flag", "path": "Flag", "short": "Key information to flag to healthcare providers", "definition": "Prospective warnings of potential issues when providing care to the patient.", "alias": [ "Barriers to Care", "Alert", "Warning" ], "min": 0, "max": "*", "base": { "path": "Resource", "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)" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)" }, { "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))" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Observation[classCode=ISSUE, moodCode=EVN]" }, { "identity": "w5", "map": "workflow.encounter" } ] }, { "id": "Flag.id", "path": "Flag.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" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Flag.meta", "path": "Flag.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", "base": { "path": "Resource.meta", "min": 0, "max": "1" }, "type": [ { "code": "Meta" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Flag.implicitRules", "path": "Flag.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.", "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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.", "min": 0, "max": "1", "base": { "path": "Resource.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Flag.language", "path": "Flag.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" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueReference": { "reference": "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": "extensible", "description": "A human language.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/languages" } }, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Flag.text", "path": "Flag.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.", "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 in formation is added later.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "DomainResource.text", "min": 0, "max": "1" }, "type": [ { "code": "Narrative" } ], "condition": [ "ele-1", "dom-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" }, { "identity": "rim", "map": "Act.text?" } ] }, { "id": "Flag.contained", "path": "Flag.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.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "base": { "path": "DomainResource.contained", "min": 0, "max": "*" }, "type": [ { "code": "Resource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Flag.extension", "path": "Flag.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "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.", "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" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "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')])" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Flag.modifierExtension", "path": "Flag.modifierExtension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "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.", "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.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "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')])" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Flag.identifier", "path": "Flag.identifier", "short": "Business identifier", "definition": "Identifier assigned to the flag for external use (outside the FHIR environment).", "min": 0, "max": "*", "base": { "path": "Flag.identifier", "min": 0, "max": "*" }, "type": [ { "code": "Identifier" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity": "rim", "map": "II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" }, { "identity": "servd", "map": "Identifier" }, { "identity": "rim", "map": ".id" }, { "identity": "w5", "map": "id" } ] }, { "id": "Flag.status", "path": "Flag.status", "short": "active | inactive | entered-in-error", "definition": "Supports basic workflow.", "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "min": 1, "max": "1", "base": { "path": "Flag.status", "min": 1, "max": "1" }, "type": [ { "code": "code", "profile": "http://hl7.org/fhir/StructureDefinition/code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mustSupport": true, "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FlagStatus" } ], "strength": "required", "description": "Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or entered in error.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/flag-status" } }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": ".status" }, { "identity": "w5", "map": "status" } ] }, { "id": "Flag.category", "path": "Flag.category", "short": "Clinical, administrative, etc.", "definition": "Allows an flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context.", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.", "min": 1, "max": "1", "base": { "path": "Flag.category", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept", "profile": "http://hl7.org/fhir/StructureDefinition/CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mustSupport": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FlagCategory" } ], "strength": "example", "description": "A general category for flags for filtering/display purposes.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/flag-category" } }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "rim", "map": ".code" }, { "identity": "w5", "map": "class" } ] }, { "id": "Flag.code", "path": "Flag.code", "short": "Coded or textual message to display to user", "definition": "The coded value or textual component of the flag to display to the user. OCP will use only the code.text (to store user entered text) part of the CodeableConcept and code.coding will not be populated. No valueset required for this.", "comment": "If non coded, use CodeableConcept.text. This element should always be included in the narrative.", "min": 1, "max": "1", "base": { "path": "Flag.code", "min": 1, "max": "1" }, "type": [ { "code": "CodeableConcept", "profile": "http://hl7.org/fhir/StructureDefinition/CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mustSupport": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FlagCode" } ], "strength": "example", "description": "Detail codes identifying specific flagged issues.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/flag-code" } }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "rim", "map": ".value" }, { "identity": "w5", "map": "what" } ] }, { "id": "Flag.subject", "path": "Flag.subject", "short": "Who/What is flag about?", "definition": "The patient, location, group , organization , or practitioner, etc. this is about record this flag is associated with. Read-only. System to autopopulate resource reference for which Flag was added. For the time being, implemented only for Patient but the same module may be used for flags related to Location, Organization, Pracititioner, etc. later.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. \r\nNote: Plan to submit FHIR Tracker to change to Reference(Any) or atleast add HealthcareService, RelatedPerson and CareTeam to support future OCP requirements.", "min": 1, "max": "1", "base": { "path": "Flag.subject", "min": 1, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Location" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Medication" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Procedure" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ocp-patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ocp-practitioner" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "rim", "map": ".participation[typeCode=SBJ].role[classCode=PAT | LOCE | ASSIGNED]" }, { "identity": "w5", "map": "who.focus" } ] }, { "id": "Flag.period", "path": "Flag.period", "short": "Time period when flag is active", "definition": "The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified.", "comment": "This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\"). If duration is required, specify the type as Interval|Duration.", "min": 1, "max": "1", "base": { "path": "Flag.period", "min": 0, "max": "1" }, "type": [ { "code": "Period", "profile": "http://hl7.org/fhir/StructureDefinition/Period" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "per-1", "severity": "error", "human": "If present, start SHALL have a lower value than end", "expression": "start.empty() or end.empty() or (start <= end)", "xpath": "not(exists(f:start)) or not(exists(f:end)) or (f:start/@value <= f:end/@value)" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "DR" }, { "identity": "rim", "map": "IVL[lowClosed=\"true\" and highClosed=\"true\"] or URG[lowClosed=\"true\" and highClosed=\"true\"]" }, { "identity": "w5", "map": "context" } ] }, { "id": "Flag.encounter", "path": "Flag.encounter", "short": "Alert relevant during encounter", "definition": "This alert is only relevant during the encounter.", "comment": "If both Flag.encounter and Flag.period are valued, then Flag.period.start shall not be before Encounter.period.start and Flag.period.end shall not be after Encounter.period.end.", "min": 0, "max": "1", "base": { "path": "Flag.encounter", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "w5", "map": "context" } ] }, { "id": "Flag.author", "path": "Flag.author", "short": "Flag creator", "definition": "The person, organization or device that created the flag. Read-only. System populated with the current user context (usually Practitioner but could be Patient or RelatedPerson). May not need to support Organization. \r\n\r\nNote: Plan to submit FHIR Tracker to change this to allow Reference to RelatedPerson since they can be part of care team.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "min": 1, "max": "1", "base": { "path": "Flag.author", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ocp-patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ocp-practitioner" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "rim", "map": ".participation[typeCode=AUT].role" }, { "identity": "w5", "map": "who.author" } ] } ] }, "differential": { "element": [ { "id": "Flag.status", "path": "Flag.status", "type": [ { "code": "code", "profile": "http://hl7.org/fhir/StructureDefinition/code" } ], "mustSupport": true }, { "id": "Flag.category", "path": "Flag.category", "min": 1, "type": [ { "code": "CodeableConcept", "profile": "http://hl7.org/fhir/StructureDefinition/CodeableConcept" } ], "mustSupport": true }, { "id": "Flag.code", "path": "Flag.code", "definition": "The coded value or textual component of the flag to display to the user. OCP will use only the code.text (to store user entered text) part of the CodeableConcept and code.coding will not be populated. No valueset required for this.", "type": [ { "code": "CodeableConcept", "profile": "http://hl7.org/fhir/StructureDefinition/CodeableConcept" } ], "mustSupport": true }, { "id": "Flag.subject", "path": "Flag.subject", "definition": "The patient, location, group , organization , or practitioner, etc. this is about record this flag is associated with. Read-only. System to autopopulate resource reference for which Flag was added. For the time being, implemented only for Patient but the same module may be used for flags related to Location, Organization, Pracititioner, etc. later.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. \r\nNote: Plan to submit FHIR Tracker to change to Reference(Any) or atleast add HealthcareService, RelatedPerson and CareTeam to support future OCP requirements.", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Location" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Medication" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Procedure" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ocp-patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ocp-practitioner" } ], "mustSupport": true }, { "id": "Flag.period", "path": "Flag.period", "definition": "The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified.", "min": 1, "type": [ { "code": "Period", "profile": "http://hl7.org/fhir/StructureDefinition/Period" } ], "mustSupport": true }, { "id": "Flag.author", "path": "Flag.author", "definition": "The person, organization or device that created the flag. Read-only. System populated with the current user context (usually Practitioner but could be Patient or RelatedPerson). May not need to support Organization. \r\n\r\nNote: Plan to submit FHIR Tracker to change this to allow Reference to RelatedPerson since they can be part of care team.", "min": 1, "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ocp-patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ocp-practitioner" } ], "mustSupport": true } ] } }