Release
4
4B
Workflow
This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
(v4.3.0:
R4B
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
).
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:
R5
R4B
R4
R4B
R4
R3
| Clinical Decision Support Work Group | Maturity Level : N/A | Standards Status : Informative | Compartments : Not linked to any defined compartments |
Raw JSON ( canonical form + also see JSON Format Specification )
Example of a predecessor/successor relationship
{
"resourceType": "ActivityDefinition",
"id": "referralPrimaryCareMentalHealth-initial",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <table class=\"grid dict\">\n <tr>\n <td>\n <b>Id: </b>\n </td>\n </tr>\n <tr>\n <td style=\"padding-left: 25px; padding-right: 25px;\">ActivityDefinition/referralPrimaryCareMentalHealth-initial</td>\n </tr>\n </table>\n <p/>\n <table class=\"grid dict\">\n <tr>\n <td>\n <b>Status: </b>\n </td>\n </tr>\n <tr>\n <td style=\"padding-left: 25px; padding-right: 25px;\">draft</td>\n </tr>\n </table>\n <p/>\n <table class=\"grid dict\">\n <tr>\n <td>\n <b>Description: </b>\n </td>\n </tr>\n <tr>\n <td style=\"padding-left: 25px; padding-right: 25px;\">refer to primary care mental-health integrated care program for evaluation and treatment of mental health conditions now</td>\n </tr>\n </table>\n <p/>\n <table class=\"grid dict\">\n <tr>\n <td>\n <b>Category: </b>\n </td>\n </tr>\n <tr>\n <td style=\"padding-left: 25px; padding-right: 25px;\">referral</td>\n </tr>\n </table>\n <p/>\n <table class=\"grid dict\">\n <tr>\n <td>\n <b>Code: </b>\n </td>\n </tr>\n <tr>\n <td style=\"padding-right: 25px;\">\n <span style=\"padding-left: 25px;\">\n <b>text: </b>\n <span>Referral to service (procedure)</span>\n <br/>\n </span>\n <span>\n <span>\n <span style=\"padding-left: 25px;\">\n <b>system: </b>\n <span>http://snomed.info/sct</span>\n <br/>\n </span>\n <span style=\"padding-left: 25px;\">\n <b>code: </b>\n <span>306206005</span>\n <br/>\n </span>\n </span>\n </span>\n </td>\n </tr>\n </table>\n <p/>\n <table class=\"grid dict\">\n <tr>\n <td>\n <b>Participant: </b>\n </td>\n </tr>\n <tr style=\"vertical-align: top;\">\n <td style=\"padding-left: 25px; padding-right: 25px;\">practitioner</td>\n </tr>\n </table>\n </div>"
"resourceType" : "ActivityDefinition",
"id" : "referralPrimaryCareMentalHealth-initial",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <table class=\"grid dict\">\n <tr>\n <td>\n <b>Id: </b>\n </td>\n </tr>\n <tr>\n <td style=\"padding-left: 25px; padding-right: 25px;\">ActivityDefinition/referralPrimaryCareMentalHealth-initial</td>\n </tr>\n </table>\n <p/>\n <table class=\"grid dict\">\n <tr>\n <td>\n <b>Status: </b>\n </td>\n </tr>\n <tr>\n <td style=\"padding-left: 25px; padding-right: 25px;\">draft</td>\n </tr>\n </table>\n <p/>\n <table class=\"grid dict\">\n <tr>\n <td>\n <b>Description: </b>\n </td>\n </tr>\n <tr>\n <td style=\"padding-left: 25px; padding-right: 25px;\">refer to primary care mental-health integrated care program for evaluation and treatment of mental health conditions now</td>\n </tr>\n </table>\n <p/>\n <table class=\"grid dict\">\n <tr>\n <td>\n <b>Category: </b>\n </td>\n </tr>\n <tr>\n <td style=\"padding-left: 25px; padding-right: 25px;\">referral</td>\n </tr>\n </table>\n <p/>\n <table class=\"grid dict\">\n <tr>\n <td>\n <b>Code: </b>\n </td>\n </tr>\n <tr>\n <td style=\"padding-right: 25px;\">\n <span style=\"padding-left: 25px;\">\n <b>text: </b>\n <span>Referral to service (procedure)</span>\n <br/>\n </span>\n <span>\n <span>\n <span style=\"padding-left: 25px;\">\n <b>system: </b>\n <span>http://snomed.info/sct</span>\n <br/>\n </span>\n <span style=\"padding-left: 25px;\">\n <b>code: </b>\n <span>306206005</span>\n <br/>\n </span>\n </span>\n </span>\n </td>\n </tr>\n </table>\n <p/>\n <table class=\"grid dict\">\n <tr>\n <td>\n <b>Participant: </b>\n </td>\n </tr>\n <tr style=\"vertical-align: top;\">\n <td style=\"padding-left: 25px; padding-right: 25px;\">practitioner</td>\n </tr>\n </table>\n </div>"
},
"url": "http://motivemi.com/artifacts/ActivityDefinition/referralPrimaryCareMentalHealth",
"identifier": [
{
"use": "official",
"system": "http://motivemi.com/artifacts",
"value": "referralPrimaryCareMentalHealth"
}
],
"version": "1.0.0",
"name": "ReferralPrimaryCareMentalHealth",
"title": "Referral to Primary Care Mental Health",
"status": "retired",
"experimental": true,
"date": "2017-03-03T14:06:00Z",
"publisher": "Motive Medical Intelligence",
"contact": [
{
"telecom": [
{
"system": "phone",
"value": "415-362-4007",
"use": "work"
},
{
"system": "email",
"value": "info@motivemi.com",
"use": "work"
}
]
}
],
"description": "refer to primary care mental-health integrated care program for evaluation and treatment of mental health conditions now",
"useContext": [
{
"code": {
"system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
"code": "age"
},
"valueCodeableConcept": {
"coding": [
{
"system": "https://meshb.nlm.nih.gov",
"code": "D000328",
"display": "Adult"
}
]
}
},
{
"code": {
"system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
"code": "focus"
},
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "87512008",
"display": "Mild major depression"
}
]
}
"url" : "http://motivemi.com/artifacts/ActivityDefinition/referralPrimaryCareMentalHealth",
"identifier" : [{
"use" : "official",
"system" : "http://motivemi.com/artifacts",
"value" : "referralPrimaryCareMentalHealth"
}],
"version" : "1.0.0",
"name" : "ReferralPrimaryCareMentalHealth",
"title" : "Referral to Primary Care Mental Health",
"status" : "retired",
"experimental" : true,
"date" : "2017-03-03T14:06:00Z",
"publisher" : "Motive Medical Intelligence",
"contact" : [{
"telecom" : [{
"system" : "phone",
"value" : "415-362-4007",
"use" : "work"
},
{
"code": {
"system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
"code": "focus"
},
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "40379007",
"display": "Major depression, recurrent, mild"
}
]
}
"system" : "email",
"value" : "info@motivemi.com",
"use" : "work"
}]
}],
"description" : "refer to primary care mental-health integrated care program for evaluation and treatment of mental health conditions now",
"useContext" : [{
"code" : {
"system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
"code" : "age"
},
{
"code": {
"system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
"code": "focus"
},
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "225444004",
"display": "At risk for suicide (finding)"
}
]
}
"valueCodeableConcept" : {
"coding" : [{
"system" : "https://meshb.nlm.nih.gov",
"code" : "D000328",
"display" : "Adult"
}]
}
},
{
"code" : {
"system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
"code" : "focus"
},
{
"code": {
"system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
"code": "focus"
},
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "306206005",
"display": "Referral to service (procedure)"
}
]
}
"valueCodeableConcept" : {
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "87512008",
"display" : "Mild major depression"
}]
}
},
{
"code" : {
"system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
"code" : "focus"
},
{
"code": {
"system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
"code": "user"
},
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "309343006",
"display": "Physician"
}
]
}
"valueCodeableConcept" : {
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "40379007",
"display" : "Major depression, recurrent, mild"
}]
}
},
{
"code" : {
"system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
"code" : "focus"
},
{
"code": {
"system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
"code": "venue"
},
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "440655000",
"display": "Outpatient environment"
}
]
}
"valueCodeableConcept" : {
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "225444004",
"display" : "At risk for suicide (finding)"
}]
}
],
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US"
}
]
},
{
"code" : {
"system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
"code" : "focus"
},
"valueCodeableConcept" : {
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "306206005",
"display" : "Referral to service (procedure)"
}]
}
],
"purpose": "Defines a referral to a mental-health integrated care program for use in suicide risk order sets. The definition is independent of the order set in which it appears to allow reuse of the general definition of the referrral.",
"usage": "This activity definition is used as the definition of a referral request within various suicide risk order sets. Elements that apply universally are defined here, while elements that apply to the specific setting of a referral within a particular order set are defined in the order set.",
"copyright": "© Copyright 2016 Motive Medical Intelligence. All rights reserved.",
"approvalDate": "2016-03-12",
"lastReviewDate": "2016-08-15",
"effectivePeriod": {
"start": "2016-01-01",
"end": "2017-12-31"
},
"topic": [
{
"text": "Mental Health Referral"
{
"code" : {
"system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
"code" : "user"
},
"valueCodeableConcept" : {
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "309343006",
"display" : "Physician"
}]
}
],
"author": [
{
"name": "Motive Medical Intelligence",
"telecom": [
{
"system": "phone",
"value": "415-362-4007",
"use": "work"
},
{
"system": "email",
"value": "info@motivemi.com",
"use": "work"
}
]
},
{
"code" : {
"system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
"code" : "venue"
},
"valueCodeableConcept" : {
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "440655000",
"display" : "Outpatient environment"
}]
}
],
"relatedArtifact": [
{
"type": "citation",
"display": "Practice Guideline for the Treatment of Patients with Major Depressive Disorder",
"url": "http://psychiatryonline.org/pb/assets/raw/sitewide/practice_guidelines/guidelines/mdd.pdf"
}],
"jurisdiction" : [{
"coding" : [{
"system" : "urn:iso:std:iso:3166",
"code" : "US"
}]
}],
"purpose" : "Defines a referral to a mental-health integrated care program for use in suicide risk order sets. The definition is independent of the order set in which it appears to allow reuse of the general definition of the referrral.",
"usage" : "This activity definition is used as the definition of a referral request within various suicide risk order sets. Elements that apply universally are defined here, while elements that apply to the specific setting of a referral within a particular order set are defined in the order set.",
"copyright" : "© Copyright 2016 Motive Medical Intelligence. All rights reserved.",
"approvalDate" : "2016-03-12",
"lastReviewDate" : "2016-08-15",
"effectivePeriod" : {
"start" : "2016-01-01",
"end" : "2017-12-31"
},
"topic" : [{
"text" : "Mental Health Referral"
}],
"author" : [{
"name" : "Motive Medical Intelligence",
"telecom" : [{
"system" : "phone",
"value" : "415-362-4007",
"use" : "work"
},
{
"type": "successor",
"resource": "ActivityDefinition/referralPrimaryCareMentalHealth"
"system" : "email",
"value" : "info@motivemi.com",
"use" : "work"
}]
}],
"relatedArtifact" : [{
"type" : "citation",
"display" : "Practice Guideline for the Treatment of Patients with Major Depressive Disorder",
"url" : "http://psychiatryonline.org/pb/assets/raw/sitewide/practice_guidelines/guidelines/mdd.pdf",
"document" : {
"url" : "http://psychiatryonline.org/pb/assets/raw/sitewide/practice_guidelines/guidelines/mdd.pdf"
}
],
"kind": "ServiceRequest",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "306206005"
}
],
"text": "Referral to service (procedure)"
},
"timingTiming": {
"_event": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/cqf-expression",
"valueExpression": {
"language": "text/cql",
"expression": "Now()"
}
}
]
}
]
{
"type" : "successor",
"resource" : "http://example.org/fhir/ActivityDefinition/referralPrimaryCareMentalHealth"
}],
"kind" : "ServiceRequest",
"code" : {
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "306206005"
}],
"text" : "Referral to service (procedure)"
},
"participant": [
{
"type": "practitioner"
}
]
"timingTiming" : {
"event" : [null],
"_event" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-expression",
"valueExpression" : {
"language" : "text/cql",
"expression" : "Now()"
}
}]
}]
},
"participant" : [{
"type" : "practitioner"
}]
}
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.
FHIR
®©
HL7.org
2011+.
FHIR
Release
4
(Technical
Correction
#1)
(v4.0.1)
4B
(v4.3.0)
hl7.fhir.r4b.core#4.3.0
generated
on
Fri,
Nov
1,
2019
09:34+1100.
QA
Page
Sat,
May
28,
2022
12:53+1000.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
QA
Page
|
Compare
to
R3
R4
|
|
Propose
a
change