Flag - FHIR Resource (stu3)


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

Validate an Flag FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
authorfalseReference Flag creator
categoryfalseCodeableConcept Clinical, administrative, etc.
codefalseCodeableConcept Coded or textual message to display to user
encounterfalseReference Alert relevant during encounter
identifiertrueIdentifier Business identifier
periodfalsePeriod Time period when flag is active
statusfalsecode active | inactive | entered-in-error
subjectfalseReference "subject" : { Reference(Patient|Location|Group|Organization|Practitioner|

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 the like so:

https://api.1up.health/fhir/stu3/Flag?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
authorreferenceauthor
datedateperiod
encounterreferenceencounter
identifiertextidentifier
patientreferencesubject
subjectreferencesubject