Basic - FHIR Resource (r4)

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

Validate an Basic FHIR Resource (r4)

Basic Attributes

AttributeField is listTypeDescription

Description: Business identifier

FHIR Version: r4

Attribute Type : Identifier

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier": [
  {
    "system": "http://goodhealth.org/basic/identifiers",
    "value": "19283746"
  }
]

Learn more about the (Basic) identifier FHIR attribute

Description: Kind of Resource

FHIR Version: r4

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"code": {
  "coding": [
    {
      "system": "http://terminology.hl7.org/CodeSystem/basic-resource-type",
      "code": "referral"
    }
  ]
}

Learn more about the (Basic) code FHIR attribute

Description: Identifies the focus of this resource

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"subject": {
  "reference": "Patient/f201",
  "display": "Roel"
}

Learn more about the (Basic) subject FHIR attribute

Description: When created

FHIR Version: r4

Attribute Type : date

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"created": "2013-05-14"

Learn more about the (Basic) created FHIR attribute

Description: "author" : { Reference(Practitioner|PractitionerRole|Patient|RelatedPerson|

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"author": {
  "reference": "Practitioner/example"
}

Learn more about the (Basic) author FHIR attribute

Basic Example

{
  "resourceType": "Basic",
  "id": "referral",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <p><b>Patient:</b>Roel</p>\n      <p><b>Requestor:</b>Dokter Bronsig</p>\n      <p><b>Type:</b>Consultation</p>\n      <p><b>Target Date:</b>April 1 - April 31</p>\n      <p>COMPLETED</p>\n      <b>The patient had fever peaks over the last couple of days. He is worried about these peaks.</b>\n    </div>"
  },
  "extension": [
    {
      "url": "http://example.org/do-not-use/fhir-extensions/referral#requestingPractitioner",
      "valueReference": {
        "reference": "Practitioner/f201",
        "display": "Dokter Bronsig"
      }
    },
    {
      "url": "http://example.org/do-not-use/fhir-extensions/referral#notes",
      "valueString": "The patient had fever peaks over the last couple of days. He is worried about these peaks."
    },
    {
      "url": "http://example.org/do-not-use/fhir-extensions/referral#fulfillingEncounter",
      "valueReference": {
        "reference": "Encounter/f201"
      }
    }
  ],
  "modifierExtension": [
    {
      "url": "http://example.org/do-not-use/fhir-extensions/referral#referredForService",
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "11429006",
            "display": "Consultation"
          }
        ]
      }
    },
    {
      "url": "http://example.org/do-not-use/fhir-extensions/referral#targetDate",
      "valuePeriod": {
        "start": "2013-04-01",
        "end": "2013-04-15"
      }
    },
    {
      "url": "http://example.org/do-not-use/fhir-extensions/referral#status",
      "valueCode": "complete"
    }
  ],
  "identifier": [
    {
      "system": "http://goodhealth.org/basic/identifiers",
      "value": "19283746"
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/basic-resource-type",
        "code": "referral"
      }
    ]
  },
  "subject": {
    "reference": "Patient/f201",
    "display": "Roel"
  },
  "created": "2013-05-14",
  "author": {
    "reference": "Practitioner/example"
  }
}

Basic Structure

{
  "resourceType" : "Basic",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business identifier
  "code" : { CodeableConcept }, // R!  Kind of Resource
  "subject" : { Reference(Any) }, // Identifies the focus of this resource
  "created" : "<date>", // When created
  "author" : { Reference(Practitioner|PractitionerRole|Patient|RelatedPerson|
   Organization) } // Who created
}

Basic Search Parameters

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

https://api.1up.health/fhir/r4/Basic?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`author`	`reference`	`author`
`code`	`text`	`code`
`created`	`date`	`created`
`identifier`	`text`	`identifier`
`patient`	`reference`	`subject.where`
`subject`	`reference`	`subject`