Clinical
Summary
This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
(v5.0.0:
R5
-
Mixed
Normative
and
STU
)
).
This
is
the
current
published
version
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
R3
R2
| Patient Care Work Group | Maturity Level : N/A | Standards Status : Informative |
Compartments
:
Encounter
,
Patient
|
Raw JSON ( canonical form + also see JSON Format Specification )
Care plan to address pregnancy
{
"resourceType": "CarePlan",
"id": "preg",
"text": {
"status": "additional",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p>A maternity care plan (for a pregnant woman).</p>\n <p>LMP is 1st Jan, 2013 (a great new years party!) The plan has activities to take prenatal vitamins, schedule first antenatal,\n and 'placeholders' for the second antenatal and delivery (there would be lots of others of course)</p>\n <p>Note that where is a proposed 'status' element against each activity</p>\n </div>"
"resourceType" : "CarePlan",
"id" : "preg",
"text" : {
"status" : "additional",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p>A maternity care plan (for a pregnant woman).</p>\n <p>LMP is 1st Jan, 2013 (a great new years party!) The plan has activities to take prenatal vitamins, schedule first antenatal,\n and 'placeholders' for the second antenatal and delivery (there would be lots of others of course)</p>\n <p>Note that where is a proposed 'status' element against each activity</p>\n </div>"
},
"contained": [
{
"resourceType": "Condition",
"id": "p1",
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"
}
]
},
"code": {
"text": "pregnancy"
"contained" : [{
"resourceType" : "Condition",
"id" : "p1",
"clinicalStatus" : {
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code" : "active"
}]
},
"verificationStatus" : {
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code" : "confirmed"
}]
},
"code" : {
"text" : "pregnancy"
},
"subject" : {
"reference" : "Patient/1",
"display" : "Eve Everywoman"
}
},
{
"resourceType" : "Practitioner",
"id" : "pr1",
"name" : [{
"family" : "Midwife",
"given" : ["Mavis"]
}]
},
{
"resourceType" : "Practitioner",
"id" : "pr2",
"name" : [{
"family" : "Obstetrician",
"given" : ["Oscar"]
}]
},
{
"resourceType" : "CareTeam",
"id" : "careteam",
"participant" : [{
"role" : {
"coding" : [{
"system" : "http://example.org/mysys",
"code" : "lmc"
}],
"text" : "Midwife"
},
"subject": {
"reference": "Patient/1",
"display": "Eve Everywoman"
"member" : {
"reference" : "#pr1",
"display" : "Mavis Midwife"
}
},
{
"resourceType": "Practitioner",
"id": "pr1",
"name": [
{
"family": "Midwife",
"given": [
"Mavis"
]
}
]
"role" : {
"coding" : [{
"system" : "http://example.org/mysys",
"code" : "obs"
}],
"text" : "Obstretitian"
},
"member" : {
"reference" : "#pr2",
"display" : "Oscar Obstetrician"
}
}]
},
{
"resourceType" : "Goal",
"id" : "goal",
"lifecycleStatus" : "active",
"description" : {
"text" : "Maintain patient's health throughout pregnancy and ensure a healthy child"
},
{
"resourceType": "Practitioner",
"id": "pr2",
"name": [
{
"family": "Obstetrician",
"given": [
"Oscar"
]
}
]
"subject" : {
"reference" : "Patient/1",
"display" : "Eve Everywoman"
}
},
{
"resourceType" : "Appointment",
"id" : "activity-1",
"status" : "booked",
"description" : "The first antenatal encounter. This is where a detailed physical examination is performed and the pregnanacy discussed with the mother-to-be.",
"start" : "2013-02-14T10:38:00+00:00",
"end" : "2013-02-14T10:50:00+00:00",
"requestedPeriod" : [{
"start" : "2013-02-14",
"end" : "2013-02-28"
}],
"subject" : {
"reference" : "Patient/1",
"display" : "Eve Everywoman"
},
"participant" : [{
"actor" : {
"reference" : "Patient/1",
"display" : "Eve Everywoman"
},
"required" : true,
"status" : "accepted"
},
{
"resourceType": "CareTeam",
"id": "careteam",
"participant": [
{
"role": [
{
"coding": [
{
"system": "http://example.org/mysys",
"code": "lmc"
}
],
"text": "Midwife"
}
],
"member": {
"reference": "#pr1",
"display": "Mavis Midwife"
}
},
{
"role": [
{
"coding": [
{
"system": "http://example.org/mysys",
"code": "obs"
}
],
"text": "Obstretitian"
}
],
"member": {
"reference": "#pr2",
"display": "Oscar Obstetrician"
}
}
]
"type" : [{
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code" : "ATND"
}]
}],
"actor" : {
"reference" : "#pr1",
"display" : "Mavis Midwife"
},
"required" : true,
"status" : "accepted"
}]
},
{
"resourceType" : "Appointment",
"id" : "activity-2",
"status" : "proposed",
"description" : "The second antenatal encounter. Discuss any issues that arose from the first antenatal encounter",
"requestedPeriod" : [{
"start" : "2013-03-01",
"end" : "2013-03-14"
}],
"subject" : {
"reference" : "Patient/1",
"display" : "Eve Everywoman"
},
"participant" : [{
"actor" : {
"reference" : "Patient/1",
"display" : "Eve Everywoman"
},
"required" : true,
"status" : "accepted"
},
{
"resourceType": "Goal",
"id": "goal",
"lifecycleStatus": "active",
"description": {
"text": "Maintain patient's health throughout pregnancy and ensure a healthy child"
"type" : [{
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code" : "ATND"
}]
}],
"actor" : {
"reference" : "#pr1",
"display" : "Mavis Midwife"
},
"subject": {
"reference": "Patient/1",
"display": "Eve Everywoman"
}
}
],
"extension": [
"required" : true,
"status" : "accepted"
}]
},
{
"resourceType" : "Appointment",
"id" : "activity-3",
"status" : "proposed",
"description" : "The delivery.",
"requestedPeriod" : [{
"start" : "2013-09-01",
"end" : "2013-09-14"
}],
"subject" : {
"reference" : "Patient/1",
"display" : "Eve Everywoman"
},
"participant" : [{
"actor" : {
"reference" : "Patient/1",
"display" : "Eve Everywoman"
},
"required" : true,
"status" : "accepted"
},
{
"url": "http://example.org/fhir/StructureDefinition/careplan#lmp",
"valueDateTime": "2013-01-01"
}
],
"status": "active",
"intent": "plan",
"subject": {
"reference": "Patient/1",
"display": "Eve Everywoman"
"type" : [{
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code" : "ATND"
}]
}],
"actor" : {
"reference" : "#pr1",
"display" : "Mavis Midwife"
},
"required" : true,
"status" : "accepted"
}]
}],
"extension" : [{
"url" : "http://example.org/fhir/StructureDefinition/careplan#lmp",
"valueDateTime" : "2013-01-01"
}],
"status" : "active",
"intent" : "plan",
"subject" : {
"reference" : "Patient/1",
"display" : "Eve Everywoman"
},
"period": {
"start": "2013-01-01",
"end": "2013-10-01"
"period" : {
"start" : "2013-01-01",
"end" : "2013-10-01"
},
"careTeam": [
{
"reference": "#careteam"
"careTeam" : [{
"reference" : "#careteam"
}],
"addresses" : [{
"reference" : {
"reference" : "#p1",
"display" : "pregnancy"
}
],
"addresses": [
{
"reference": "#p1",
"display": "pregnancy"
}],
"goal" : [{
"reference" : "#goal"
}],
"activity" : [{
"plannedActivityReference" : {
"display" : "Prenatal vitamin MedicationRequest"
}
],
"goal": [
{
"reference": "#goal"
},
{
"extension" : [{
"url" : "http://example.org/fhir/StructureDefinition/careplan#andetails",
"valueUri" : "http://orionhealth.com/fhir/careplan/1andetails"
}],
"plannedActivityReference" : {
"reference" : "#activity-1"
}
],
"activity": [
{
"reference": {
"display": "Prenatal vitamin MedicationRequest"
}
},
{
"extension": [
{
"url": "http://example.org/fhir/StructureDefinition/careplan#andetails",
"valueUri": "http://orionhealth.com/fhir/careplan/1andetails"
}
],
"detail": {
"kind": "Appointment",
"code": {
"coding": [
{
"system": "http://example.org/mySystem",
"code": "1an"
}
],
"text": "First Antenatal encounter"
},
"status": "scheduled",
"doNotPerform": false,
"scheduledTiming": {
"repeat": {
"boundsPeriod": {
"start": "2013-02-14",
"end": "2013-02-28"
}
}
},
"performer": [
{
"reference": "#pr1",
"display": "Mavis Midwife"
}
],
"description": "The first antenatal encounter. This is where a detailed physical examination is performed. and the pregnanacy discussed with the mother-to-be."
}
},
{
"detail": {
"kind": "Appointment",
"code": {
"coding": [
{
"system": "http://example.org/mySystem",
"code": "an"
}
],
"text": "Follow-up Antenatal encounter"
},
"status": "not-started",
"doNotPerform": false,
"scheduledTiming": {
"repeat": {
"boundsPeriod": {
"start": "2013-03-01",
"end": "2013-03-14"
}
}
},
"performer": [
{
"reference": "#pr1",
"display": "Mavis Midwife"
}
],
"description": "The second antenatal encounter. Discuss any issues that arose from the first antenatal encounter"
}
},
{
"detail": {
"kind": "Appointment",
"code": {
"coding": [
{
"system": "http://example.org/mySystem",
"code": "del"
}
],
"text": "Delivery"
},
"status": "not-started",
"doNotPerform": false,
"scheduledTiming": {
"repeat": {
"boundsPeriod": {
"start": "2013-09-01",
"end": "2013-09-14"
}
}
},
"performer": [
{
"reference": "#pr1",
"display": "Mavis Midwife"
}
],
"description": "The delivery."
}
},
{
"plannedActivityReference" : {
"reference" : "#activity-2"
}
]
},
{
"plannedActivityReference" : {
"reference" : "#activity-3"
}
}]
}
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)
R5
hl7.fhir.core#5.0.0
generated
on
Fri,
Nov
1,
2019
09:34+1100.
QA
Page
Sun,
Mar
26,
2023
15:24+1100.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
R3
R4
|
Compare
to
R4B
|
|
Propose
a
change