Flag - FHIR Resource (stu3)

This Flag Resource uses the FHIR API standard for access and structure.

Validate an Flag FHIR Resource (stu3)

Flag Attributes

AttributeField is listTypeDescription

Description: active | inactive | entered-in-error

FHIR Version: stu3

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"status": "inactive"

Learn more about the (Flag) status FHIR attribute

Description: Clinical, administrative, etc.

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"category": {
  "text": "admin",
  "coding": [
    {
      "code": "admin",
      "system": "http://example.org/local",
      "display": "Admin"
    }
  ]
}

Learn more about the (Flag) category FHIR attribute

Description: Coded or textual message to display to user

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"code": {
  "text": "Patient has a big dog at his home. Always always wear a suit of armor or take other active counter-measures",
  "coding": [
    {
      "code": "bigdog",
      "system": "http://example.org/local",
      "display": "Big dog"
    }
  ]
}

Learn more about the (Flag) code FHIR attribute

Description: Flag creator

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"author": {
  "display": "Nancy Nurse",
  "reference": "Practitioner/example"
}

Learn more about the (Flag) author FHIR attribute

Description: Time period when flag is active

FHIR Version: stu3

Attribute Type : Period

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"period": {
  "start": "2015-01-17",
  "end": "2016-12-01"
}

Learn more about the (Flag) period FHIR attribute

Description: Business identifier

FHIR Version: stu3

Attribute Type : Identifier

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier": [
  {
    "value": "12345"
  }
]

Learn more about the (Flag) identifier FHIR attribute

Description: Alert relevant during encounter

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"encounter":

Learn more about the (Flag) encounter FHIR attribute

Description: "subject" : { Reference(Patient|Location|Group|Organization|Practitioner|

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"subject": {
  "display": "Peter Patient",
  "reference": "Patient/example"
}

Learn more about the (Flag) subject FHIR attribute

Flag Example

{
  "status": "inactive",
  "category": {
    "text": "admin",
    "coding": [
      {
        "code": "admin",
        "system": "http://example.org/local",
        "display": "Admin"
      }
    ]
  },
  "code": {
    "text": "Patient has a big dog at his home. Always always wear a suit of armor or take other active counter-measures",
    "coding": [
      {
        "code": "bigdog",
        "system": "http://example.org/local",
        "display": "Big dog"
      }
    ]
  },
  "author": {
    "display": "Nancy Nurse",
    "reference": "Practitioner/example"
  },
  "resourceType": "Flag",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Large Dog warning for Peter Patient</div>"
  },
  "period": {
    "start": "2015-01-17",
    "end": "2016-12-01"
  },
  "identifier": [
    {
      "value": "12345"
    }
  ],
  "id": "example",
  "subject": {
    "display": "Peter Patient",
    "reference": "Patient/example"
  }
}

Flag Structure


  
{
  "resourceType" : "Flag",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business identifier
  "status" : "<code>", // R!  active | inactive | entered-in-error
  "category" : { CodeableConcept }, // Clinical, administrative, etc.
  "code" : { CodeableConcept }, // R!  Coded or textual message to display to user
  "subject" : { Reference(Patient|Location|Group|Organization|Practitioner|
   PlanDefinition|Medication|Procedure) }, // R!  Who/What is flag about?
  "period" : { Period }, // Time period when flag is active
  "encounter" : { Reference(Encounter) }, // Alert relevant during encounter
  "author" : { Reference(Device|Organization|Patient|Practitioner) } // Flag creator
}

Flag Search Parameters

The following search parameters can be used to query Flag resources. Just submit them like so:

https://api.1up.health/fhir/stu3/Flag?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`author`	`reference`	`author`
`date`	`date`	`period`
`encounter`	`reference`	`encounter`
`identifier`	`text`	`identifier`
`patient`	`reference`	`subject`
`subject`	`reference`	`subject`