# Get FHIR r4 plan definition by ID

Endpoint: GET /site/{siteId}/fhir/plan-definition/{id}
Version: 1.0
Security: bearer, bearer

## Path parameters:

  - `id` (string, required)
    ID of the PlanDefinition

  - `siteId` (string, required)
    Site identifier

## Response 200 fields (application/json):

  - `resourceType` (any, required)
    This is a PlanDefinition resource
    Enum: "PlanDefinition"

  - `id` (string)
    Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters.  (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.)  Ids are case-insensitive.
    Example: "example-id"

  - `meta` (object)
    The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

  - `meta.id` (string)
    An extension object type #string.
    Example: "example-string"

  - `meta.extension` (array)
    May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

  - `meta.versionId` (object)
    An extension object type #id.

  - `meta._versionId` (object)
    An extension object type #Element.

  - `meta.lastUpdated` (object)
    An extension object type #instant.

  - `meta._lastUpdated` (object)
    An extension object type #Element.

  - `meta.source` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `meta._source` (object)
    An extension object type #Element.

  - `meta.profile` (array)
    A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].
    Example: ["http://example.org/Profile"]

  - `meta.security` (array)
    Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

  - `meta.tag` (array)
    Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

  - `implicitRules` (string)
    String of characters used to identify a name or a resource
    Example: "https://example.org/resource"

  - `_implicitRules` (object)
    Base definition for all elements in a resource.

  - `language` (string)
    A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
    Example: "sample-code"

  - `_language` (object)
    Base definition for all elements in a resource.

  - `text` (object)
    A human-readable summary of the resource conveying the essential clinical and business information for the resource.

  - `text.status` (any)
    The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
    Enum: "generated", "extensions", "additional", "empty"

  - `text._status` (object)
    An extension object type #Element.

  - `text.div` (string, required)
    An extension object type #xhtml.
    Example: "<div>Example</div>"

  - `contained` (array)
    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.
    Example: [{"resourceType":"ActivityDefinition","id":"referralToMentalHealthCare","status":"draft","description":"refer to primary care mental-health integrated care program for evaluation and treatment of mental health conditions now","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()"}}]}]},"participant":[{"type":"practitioner"}]},{"resourceType":"ActivityDefinition","id":"citalopramPrescription","status":"draft","kind":"MedicationRequest","productReference":{"reference":"#citalopramMedication"},"dosage":[{"text":"1 tablet oral 1 time daily","timing":{"repeat":{"frequency":1,"period":1,"periodUnit":"d"}},"route":{"coding":[{"code":"26643006","display":"Oral route (qualifier value)"}],"text":"Oral route (qualifier value)"},"doseAndRate":[{"type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/dose-rate-type","code":"ordered","display":"Ordered"}]},"doseQuantity":{"value":1,"unit":"{tbl}"}}]}],"dynamicValue":[{"path":"dispenseRequest.numberOfRepeatsAllowed","expression":{"language":"text/cql","expression":"3"}},{"path":"dispenseRequest.quantity","expression":{"language":"text/cql","expression":"30 \"{tbl}\""}}]},{"resourceType":"Medication","id":"citalopramMedication","code":{"coding":[{"system":"http://www.nlm.nih.gov/research/umls/rxnorm","code":"200371"}],"text":"citalopram"},"form":{"coding":[{"system":"http://snomed.info/sct","code":"385055001","display":"Tablet dose form"}],"text":"Tablet dose form"},"ingredient":[{"itemReference":{"reference":"#citalopramSubstance"},"strength":{"numerator":{"value":20,"unit":"mg"},"denominator":{"value":1,"unit":"{tbl}"}}}]},{"resourceType":"Substance","id":"citalopramSubstance","code":{"coding":[{"system":"http://www.nlm.nih.gov/research/umls/rxnorm","code":"2556"}],"text":"citalopram"}}]

  - `extension` (array)
    May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

  - `extension.url` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `extension._url` (object)
    An extension object type #Element.

  - `extension.valueBase64Binary` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "U2FtcGxl"

  - `extension._valueBase64Binary` (object)
    An extension object type #Element.

  - `extension.valueBoolean` (boolean)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: true

  - `extension._valueBoolean` (object)
    An extension object type #Element.

  - `extension.valueCanonical` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "http://example.org/Profile"

  - `extension._valueCanonical` (object)
    An extension object type #Element.

  - `extension.valueCode` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "sample-code"

  - `extension._valueCode` (object)
    An extension object type #Element.

  - `extension.valueDate` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01"

  - `extension._valueDate` (object)
    An extension object type #Element.

  - `extension.valueDateTime` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01T00:00:00Z"

  - `extension._valueDateTime` (object)
    An extension object type #Element.

  - `extension.valueDecimal` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1.23

  - `extension._valueDecimal` (object)
    An extension object type #Element.

  - `extension.valueId` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "example-id"

  - `extension._valueId` (object)
    An extension object type #Element.

  - `extension.valueInstant` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01T00:00:00Z"

  - `extension._valueInstant` (object)
    An extension object type #Element.

  - `extension.valueInteger` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1

  - `extension._valueInteger` (object)
    An extension object type #Element.

  - `extension.valueMarkdown` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "Sample markdown text"

  - `extension._valueMarkdown` (object)
    An extension object type #Element.

  - `extension.valueOid` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "urn:oid:1.2.3.4.5"

  - `extension._valueOid` (object)
    An extension object type #Element.

  - `extension.valuePositiveInt` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1

  - `extension._valuePositiveInt` (object)
    An extension object type #Element.

  - `extension.valueString` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "example-string"

  - `extension._valueString` (object)
    An extension object type #Element.

  - `extension.valueTime` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "12:00:00"

  - `extension._valueTime` (object)
    An extension object type #Element.

  - `extension.valueUnsignedInt` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).

  - `extension._valueUnsignedInt` (object)
    An extension object type #Element.

  - `extension.valueUri` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "https://example.org/resource"

  - `extension._valueUri` (object)
    An extension object type #Element.

  - `extension.valueUrl` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "https://example.org"

  - `extension._valueUrl` (object)
    An extension object type #Element.

  - `extension.valueUuid` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000"

  - `extension._valueUuid` (object)
    An extension object type #Element.

  - `extension.valueAddress` (object)
    An extension object type #Address.

  - `extension.valueAge` (object)
    An extension object type #Age.

  - `extension.valueAnnotation` (object)
    An extension object type #Annotation.

  - `extension.valueAttachment` (object)
    An extension object type #Attachment.

  - `extension.valueCodeableConcept` (object)
    An extension object type #CodeableConcept.

  - `extension.valueCoding` (object)
    An extension object type #Coding.

  - `extension.valueContactPoint` (object)
    An extension object type #ContactPoint.

  - `extension.valueCount` (object)
    An extension object type #Count.

  - `extension.valueDistance` (object)
    An extension object type #Distance.

  - `extension.valueDuration` (object)
    An extension object type #Duration.

  - `extension.valueHumanName` (object)
    An extension object type #HumanName.

  - `extension.valueIdentifier` (object)
    An extension object type #Identifier.

  - `extension.valueMoney` (object)
    An extension object type #Money.

  - `extension.valuePeriod` (object)
    An extension object type #Period.

  - `extension.valueQuantity` (object)
    An extension object type #Quantity.

  - `extension.valueRange` (object)
    An extension object type #Range.

  - `extension.valueRatio` (object)
    An extension object type #Ratio.

  - `extension.valueReference` (object)
    An extension object type #Reference.

  - `extension.valueSampledData` (object)
    An extension object type #SampledData.

  - `extension.valueSignature` (object)
    An extension object type #Signature.

  - `extension.valueTiming` (object)
    An extension object type #Timing.

  - `extension.valueContactDetail` (object)
    An extension object type #ContactDetail.

  - `extension.valueContributor` (object)
    An extension object type #Contributor.

  - `extension.valueDataRequirement` (object)
    An extension object type #DataRequirement.

  - `extension.valueExpression` (object)
    An extension object type #Expression.

  - `extension.valueParameterDefinition` (object)
    An extension object type #ParameterDefinition.

  - `extension.valueRelatedArtifact` (object)
    An extension object type #RelatedArtifact.

  - `extension.valueTriggerDefinition` (object)
    An extension object type #TriggerDefinition.

  - `extension.valueUsageContext` (object)
    An extension object type #UsageContext.

  - `extension.valueDosage` (object)
    An extension object type #Dosage.

  - `extension.valueMeta` (object)
    An extension object type #Meta.

  - `modifierExtension` (array)
    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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

  - `url` (string)
    String of characters used to identify a name or a resource
    Example: "https://example.org/resource"

  - `_url` (object)
    Base definition for all elements in a resource.

  - `identifier` (array)
    A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
    Example: [{"use":"official","system":"http://motivemi.com/artifacts","value":"mmi:low-suicide-risk-order-set"}]

  - `identifier.use` (any)
    The purpose of this identifier.
    Enum: "usual", "official", "temp", "secondary", "old"

  - `identifier._use` (object)
    An extension object type #Element.

  - `identifier.type` (object)
    An extension object type #CodeableConcept.

  - `identifier.system` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `identifier._system` (object)
    An extension object type #Element.

  - `identifier.value` (string)
    An extension object type #string.
    Example: "example-string"

  - `identifier._value` (object)
    An extension object type #Element.

  - `identifier.period` (object)
    An extension object type #Period.

  - `identifier.assigner` (object)
    An extension object type #Reference.

  - `version` (string)
    A sequence of Unicode characters
    Example: "example-string"

  - `_version` (object)
    Base definition for all elements in a resource.

  - `name` (string)
    A sequence of Unicode characters
    Example: "example-string"

  - `_name` (object)
    Base definition for all elements in a resource.

  - `title` (string)
    A sequence of Unicode characters
    Example: "example-string"

  - `_title` (object)
    Base definition for all elements in a resource.

  - `subtitle` (string)
    A sequence of Unicode characters
    Example: "example-string"

  - `_subtitle` (object)
    Base definition for all elements in a resource.

  - `type` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `type.coding` (array)
    A reference to a code defined by a terminology system.

  - `type.text` (string)
    An extension object type #string.
    Example: "example-string"

  - `type._text` (object)
    An extension object type #Element.

  - `status` (any)
    The status of this plan definition. Enables tracking the life-cycle of the content.
    Enum: "draft", "active", "retired", "unknown"

  - `_status` (object)
    Base definition for all elements in a resource.

  - `experimental` (boolean)
    Value of "true" or "false"
    Example: true

  - `_experimental` (object)
    Base definition for all elements in a resource.

  - `subjectCodeableConcept` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `subjectReference` (object)
    A reference from one resource to another.

  - `subjectReference.reference` (string)
    An extension object type #string.
    Example: "example-string"

  - `subjectReference._reference` (object)
    An extension object type #Element.

  - `subjectReference.type` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `subjectReference._type` (object)
    An extension object type #Element.

  - `subjectReference.identifier` (object)
    An extension object type #Identifier.

  - `subjectReference.display` (string)
    An extension object type #string.
    Example: "example-string"

  - `subjectReference._display` (object)
    An extension object type #Element.

  - `date` (string)
    A date, date-time or partial date (e.g. just year or year + month).  If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored.                 Dates SHALL be valid dates.
    Example: "2024-01-01T00:00:00Z"

  - `_date` (object)
    Base definition for all elements in a resource.

  - `publisher` (string)
    A sequence of Unicode characters
    Example: "example-string"

  - `_publisher` (object)
    Base definition for all elements in a resource.

  - `contact` (array)
    Contact details to assist a user in finding and communicating with the publisher.
    Example: [{"telecom":[{"system":"phone","value":"415-362-4007","use":"work"},{"system":"email","value":"info@motivemi.com","use":"work"}]}]

  - `contact.name` (string)
    An extension object type #string.
    Example: "example-string"

  - `contact._name` (object)
    An extension object type #Element.

  - `contact.telecom` (array)
    The contact details for the individual (if a name was provided) or the organization.

  - `description` (string)
    A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
    Example: "Sample markdown text"

  - `_description` (object)
    Base definition for all elements in a resource.

  - `useContext` (array)
    The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.
    Example: [{"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"}]}},{"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"}]}},{"code":{"system":"http://terminology.hl7.org/CodeSystem/usage-context-type","code":"focus"},"valueCodeableConcept":{"coding":[{"system":"http://snomed.info/sct","code":"394687007","display":"Low suicide risk"}]}},{"code":{"system":"http://terminology.hl7.org/CodeSystem/usage-context-type","code":"focus"},"valueCodeableConcept":{"coding":[{"system":"http://snomed.info/sct","code":"225337009","display":"Suicide risk assessment"}]}},{"code":{"system":"http://terminology.hl7.org/CodeSystem/usage-context-type","code":"user"},"valueCodeableConcept":{"coding":[{"system":"http://snomed.info/sct","code":"309343006","display":"Physician"}]}},{"code":{"system":"http://terminology.hl7.org/CodeSystem/usage-context-type","code":"venue"},"valueCodeableConcept":{"coding":[{"system":"http://snomed.info/sct","code":"440655000","display":"Outpatient environment"}]}}]

  - `useContext.code` (object, required)
    An extension object type #Coding.

  - `jurisdiction` (array)
    A legal or geographic region in which the plan definition is intended to be used.
    Example: [{"coding":[{"system":"urn:iso:std:iso:3166","code":"US"}]}]

  - `purpose` (string)
    A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
    Example: "Sample markdown text"

  - `_purpose` (object)
    Base definition for all elements in a resource.

  - `usage` (string)
    A sequence of Unicode characters
    Example: "example-string"

  - `_usage` (object)
    Base definition for all elements in a resource.

  - `copyright` (string)
    A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
    Example: "Sample markdown text"

  - `_copyright` (object)
    Base definition for all elements in a resource.

  - `approvalDate` (string)
    A date or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date.  Dates SHALL be valid dates.
    Example: "2024-01-01"

  - `_approvalDate` (object)
    Base definition for all elements in a resource.

  - `lastReviewDate` (string)
    A date or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date.  Dates SHALL be valid dates.
    Example: "2024-01-01"

  - `_lastReviewDate` (object)
    Base definition for all elements in a resource.

  - `effectivePeriod` (object)
    A time period defined by a start and end date and optionally time.

  - `effectivePeriod.start` (string)
    An extension object type #dateTime.
    Example: "2024-01-01T00:00:00Z"

  - `effectivePeriod._start` (object)
    An extension object type #Element.

  - `effectivePeriod.end` (string)
    An extension object type #dateTime.
    Example: "2024-01-01T00:00:00Z"

  - `effectivePeriod._end` (object)
    An extension object type #Element.

  - `topic` (array)
    Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.
    Example: [{"text":"Suicide risk assessment"}]

  - `author` (array)
    An individiual or organization primarily involved in the creation and maintenance of the content.
    Example: [{"name":"Motive Medical Intelligence","telecom":[{"system":"phone","value":"415-362-4007","use":"work"},{"system":"email","value":"info@motivemi.com","use":"work"}]}]

  - `editor` (array)
    An individual or organization primarily responsible for internal coherence of the content.

  - `reviewer` (array)
    An individual or organization primarily responsible for review of some aspect of the content.

  - `endorser` (array)
    An individual or organization responsible for officially endorsing the content for use in some setting.

  - `relatedArtifact` (array)
    Related artifacts such as additional documentation, justification, or bibliographic references.
    Example: [{"type":"derived-from","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"},{"type":"composed-of","resource":"ActivityDefinition/referralPrimaryCareMentalHealth"},{"type":"composed-of","resource":"ActivityDefinition/citalopramPrescription"}]

  - `relatedArtifact.type` (any)
    The type of relationship to the related artifact.
    Enum: "documentation", "justification", "citation", "predecessor", "successor", "derived-from", "depends-on", "composed-of"

  - `relatedArtifact.label` (string)
    An extension object type #string.
    Example: "example-string"

  - `relatedArtifact._label` (object)
    An extension object type #Element.

  - `relatedArtifact.citation` (object)
    An extension object type #markdown.

  - `relatedArtifact._citation` (object)
    An extension object type #Element.

  - `relatedArtifact.url` (string)
    An extension object type #url.
    Example: "https://example.org"

  - `relatedArtifact.document` (object)
    An extension object type #Attachment.

  - `relatedArtifact.resource` (string)
    An extension object type #canonical.
    Example: "http://example.org/Profile"

  - `library` (array)
    A reference to a Library resource containing any formal logic used by the plan definition.
    Example: ["Library/suiciderisk-orderset-logic"]

  - `goal` (array)
    Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.

  - `goal.modifierExtension` (array)
    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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

  - `goal.category` (object)
    An extension object type #CodeableConcept.

  - `goal.description` (object, required)
    An extension object type #CodeableConcept.

  - `goal.priority` (object)
    An extension object type #CodeableConcept.

  - `goal.start` (object)
    An extension object type #CodeableConcept.

  - `goal.addresses` (array)
    Identifies problems, conditions, issues, or concerns the goal is intended to address.

  - `goal.documentation` (array)
    Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.

  - `goal.target` (array)
    Indicates what should be done and within what timeframe.

  - `action` (array)
    An action or group of actions to be taken as part of the plan.
    Example: [{"title":"Suicide Risk Assessment and Outpatient Management","action":[{"title":"Consults and Referrals","groupingBehavior":"logical-group","selectionBehavior":"any","action":[{"textEquivalent":"Refer to outpatient mental health program for evaluation and treatment of mental health conditions now","definitionCanonical":"#referralToMentalHealthCare","dynamicValue":[{"path":"timing.event","expression":{"language":"text/cql","expression":"Now()"}},{"path":"specialty","expression":{"language":"text/cql","expression":"Code \"261QM0850X\" from SuicideRiskLogic.\"NUCC Provider Taxonomy\" display \"Adult Mental Health\""}},{"path":"occurrenceDateTime","expression":{"language":"text/cql","expression":"SuicideRiskLogic.ServiceRequestFulfillmentTime"}},{"path":"subject","expression":{"language":"text/cql","expression":"SuicideRiskLogic.Patient"}},{"path":"requester.agent","expression":{"language":"text/cql","expression":"SuicideRiskLogic.Practitioner"}},{"path":"reasonCode","expression":{"language":"text/cql","expression":"SuicideRiskLogic.RiskAssessmentScore"}},{"path":"reasonReference","expression":{"language":"text/cql","expression":"SuicideRiskLogic.RiskAssessment"}}]}]},{"title":"Medications","groupingBehavior":"logical-group","selectionBehavior":"at-most-one","action":[{"title":"First-Line Antidepressants","documentation":[{"type":"citation","document":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/evidence-quality","code":"high"}],"text":"High Quality"}}],"contentType":"text/html","url":"http://psychiatryonline.org/pb/assets/raw/sitewide/practice_guidelines/guidelines/mdd.pdf","title":"Practice Guideline for the Treatment of Patients with Major Depressive Disorder"}}],"groupingBehavior":"logical-group","selectionBehavior":"at-most-one","action":[{"title":"Selective Serotonin Reuptake Inhibitors (Choose a mazimum of one or document reasons for exception)","documentation":[{"type":"citation","document":{"contentType":"text/html","url":"http://dailymed.nlm.nih.gov/dailymed/drugInfo.cfm?setid=6daeb45c-451d-b135-bf8f-2d6dff4b6b01","title":"National Library of Medicine. DailyMed website. CITALOPRAM- citalopram hydrobromide tablet, film coated."}}],"groupingBehavior":"logical-group","selectionBehavior":"at-most-one","action":[{"textEquivalent":"citalopram 20 mg tablet 1 tablet oral 1 time daily now (30 table; 3 refills)","definitionCanonical":"#citalopramPrescription","dynamicValue":[{"path":"status","expression":{"language":"text/cql","expression":"\"draft\""}},{"path":"patient","expression":{"language":"text/cql","expression":"SuicideRiskLogic.Patient"}},{"path":"prescriber","expression":{"language":"text/cql","expression":"SuicideRiskLogic.Practitioner"}},{"path":"reasonCode","expression":{"language":"text/cql","expression":"SuicideRiskLogic.RiskAssessmentScore"}},{"path":"reasonReference","expression":{"language":"text/cql","expression":"SuicideRiskLogic.RiskAssessment"}}]},{"textEquivalent":"escitalopram 10 mg tablet 1 tablet oral 1 time daily now (30 tablet; 3 refills)"},{"textEquivalent":"fluoxetine 20 mg capsule 1 capsule oral 1 time daily now (30 tablet; 3 refills)"},{"textEquivalent":"paroxetine 20 mg tablet 1 tablet oral 1 time daily now (30 tablet; 3 refills)"},{"textEquivalent":"sertraline 50 mg tablet 1 tablet oral 1 time daily now (30 tablet; 3 refills)"}]},{"textEquivalent":"Dopamine Norepinephrine Reuptake Inhibitors (Choose a maximum of one or document reasons for exception)"},{"textEquivalent":"Serotonin Norepinephrine Reuptake Inhibitors (Choose a maximum of one or doument reasons for exception)"},{"textEquivalent":"Norepinephrine-Serotonin Modulators (Choose a maximum of one or document reasons for exception)"}]}]}]}]

  - `action.prefix` (string)
    An extension object type #string.
    Example: "example-string"

  - `action._prefix` (object)
    An extension object type #Element.

  - `action.title` (string)
    An extension object type #string.
    Example: "example-string"

  - `action._title` (object)
    An extension object type #Element.

  - `action.description` (string)
    An extension object type #string.
    Example: "example-string"

  - `action._description` (object)
    An extension object type #Element.

  - `action.textEquivalent` (string)
    An extension object type #string.
    Example: "example-string"

  - `action._textEquivalent` (object)
    An extension object type #Element.

  - `action.priority` (string)
    An extension object type #code.
    Example: "sample-code"

  - `action._priority` (object)
    An extension object type #Element.

  - `action.code` (array)
    A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

  - `action.reason` (array)
    A description of why this action is necessary or appropriate.

  - `action.documentation` (array)
    Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.

  - `action.goalId` (array)
    Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.

  - `action._goalId` (array)
    Extensions for goalId

  - `action.subjectCodeableConcept` (object)
    An extension object type #CodeableConcept.

  - `action.subjectReference` (object)
    An extension object type #Reference.

  - `action.trigger` (array)
    A description of when the action should be triggered.

  - `action.condition` (array)
    An expression that describes applicability criteria or start/stop conditions for the action.

  - `action.input` (array)
    Defines input data requirements for the action.

  - `action.output` (array)
    Defines the outputs of the action, if any.

  - `action.relatedAction` (array)
    A relationship to another action such as "before" or "30-60 minutes after start of".

  - `action.timingDateTime` (string)
    An optional value describing when the action should be performed.
    Example: "2024-01-01T00:00:00Z"

  - `action._timingDateTime` (object)
    An extension object type #Element.

  - `action.timingAge` (object)
    An extension object type #Age.

  - `action.timingPeriod` (object)
    An extension object type #Period.

  - `action.timingDuration` (object)
    An extension object type #Duration.

  - `action.timingRange` (object)
    An extension object type #Range.

  - `action.timingTiming` (object)
    An extension object type #Timing.

  - `action.participant` (array)
    Indicates who should participate in performing the action described.

  - `action.groupingBehavior` (any)
    Defines the grouping behavior for the action and its children.
    Enum: "visual-group", "logical-group", "sentence-group"

  - `action._groupingBehavior` (object)
    An extension object type #Element.

  - `action.selectionBehavior` (any)
    Defines the selection behavior for the action and its children.
    Enum: "any", "all", "all-or-none", "exactly-one", "at-most-one", "one-or-more"

  - `action._selectionBehavior` (object)
    An extension object type #Element.

  - `action.requiredBehavior` (any)
    Defines the required behavior for the action.
    Enum: "must", "could", "must-unless-documented"

  - `action._requiredBehavior` (object)
    An extension object type #Element.

  - `action.precheckBehavior` (any)
    Defines whether the action should usually be preselected.
    Enum: "yes", "no"

  - `action._precheckBehavior` (object)
    An extension object type #Element.

  - `action.cardinalityBehavior` (any)
    Defines whether the action can be selected multiple times.
    Enum: "single", "multiple"

  - `action._cardinalityBehavior` (object)
    An extension object type #Element.

  - `action.definitionCanonical` (string)
    A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.
    Example: "example-string"

  - `action._definitionCanonical` (object)
    An extension object type #Element.

  - `action.definitionUri` (string)
    A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.
    Example: "example-string"

  - `action._definitionUri` (object)
    An extension object type #Element.

  - `action.transform` (string)
    An extension object type #canonical.
    Example: "http://example.org/Profile"

  - `action.dynamicValue` (array)
    Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.

  - `action.action` (array)
    Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

## Response 401 fields (application/json):

  - `message` (string, required)
    Error message indicating unauthorized access.
    Example: "Unauthorized"

  - `statusCode` (number, required)
    HTTP status code for unauthorized access.
    Example: 401


## Response 400 fields

## Response 404 fields