Note: There is a newer version (6.0.0) of this package available. Click here to view docs for the latest version.

Modules

health.fhir.r4

health.fhir.r4.parser health.fhir.r4.terminology health.fhir.r4.validator

Module health.fhir.r4

ballerinax/health.fhir.r4 Ballerina library

3.0.1

FHIR R4 Base module

Sample Usage

This section focuses on samples depicting how to use this package to implement FHIR related integrations

Prerequisites

Install Ballerina 2201.5.0 or later

1. Parse JSON FHIR resource to FHIR resource model

Sample below is using the Patient resource in health.fhir.r4 package.


import ballerinax/health.fhir.r4;


function parseSamplePatient() returns r4:Patient {
    json patientPayload = {
        "resourceType": "Patient",
        "id": "1",
        "meta": {
            "profile": [
                "http://hl7.org/fhir/StructureDefinition/Patient"
            ]
        },
        "active":true,
        "name":[
            {
                "use":"official",
                "family":"Chalmers",
                "given":[
                    "Peter",
                    "James"
                ]
            }
        ],
        "gender":"male",
        "birthDate":"1974-12-25",
        "managingOrganization":{
            "reference":"Organization/1"
        }
    };

    do {
        anydata parsedResult = check parse(patientPayload, r4:Patient);
        r4:Patient patientModel = check parsedResult.ensureType();
        log:printInfo(string `Patient name : ${patientModel.name.toString()}`);
        return patientModel;
    } on fail error parseError {
    	log:printError(string `Error occurred while parsing : ${parseError.message()}`, parseError);
    }
}

2. Creating FHIR Resource models and serializing to JSON wire formats


import ballerinax/health.fhir.r4;


function createSamplePatient() returns json {
    r4:Patient patient = {
        meta: {
            lastUpdated: time:utcToString(time:utcNow()),
            profile: [r4:PROFILE_BASE_PATIENT]
        },
        active: true,
        name: [{
            family: "Doe",
            given: ["Jhon"],
            use: r4:official,
            prefix: ["Mr"]
        }],
        address: [{
            line: ["652 S. Lantern Dr."],
            city: "New York",
            country: "United States",
            postalCode: "10022",
            'type: r4:physical,
            use: r4:home
        }]
    };
    FHIRResourceEntity fhirEntity = new(patient);
    // Serialize FHIR resource record to Json payload
    json|FHIRSerializerError jsonResult = fhirEntity.toJson();
    if jsonResult is json {
        log:printInfo(string `Patient resource JSON payload : ${jsonResult.toString()}`);
        return jsonResult;
    } else {
        log:printError(string `Error occurred while serializing to JSON payload : ${jsonResult.message()}`, jsonResult);
    }
}

Functions

annotationDataTypeValidationFunction

Isolated Function

function annotationDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns FHIRValidationError?

This function validates the data type definition of Annotation.

Parameters

data anydata - Data to be validated

elementContextDefinition ElementAnnotationDefinition - Element definition of the data

Return Type

FHIRValidationError? - FHIRValidationError array if data is not valid or else nil

clientErrorToFhirError

Isolated Function

function clientErrorToFhirError(ClientError clientError) returns FHIRError

Convert a http client error to a FHIR error.

Parameters

clientError ClientError - http:ClientError.

Return Type

FHIRError - Return a FHIR error.

compareResources

Isolated Function

function compareResources(ResourceCompareRequestData resourceCompareRequestData) returns error|Response

Parameters

resourceCompareRequestData ResourceCompareRequestData -

complexDataTypeJsonSerializer

Isolated Function

function complexDataTypeJsonSerializer(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRWireFormat|FHIRSerializerError)?

Serializes a complex data type to a JSON representation

Parameters

data anydata - data to be serialized

elementContextDefinition ElementAnnotationDefinition - element definition of the data

Return Type

(FHIRWireFormat|FHIRSerializerError)? - JSON representation of the data

complexDataTypeXMLSerializer

Isolated Function

function complexDataTypeXMLSerializer(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRWireFormat|FHIRSerializerError)?

Serializes a complex data type to a XML representation

Parameters

data anydata - data to be serialized

elementContextDefinition ElementAnnotationDefinition - element definition of the data

Return Type

(FHIRWireFormat|FHIRSerializerError)? - XML representation of the data

createFhirBundle

Isolated Function

function createFhirBundle(BundleType t, DomainResource[] resources) returns Bundle

Create a FHIR Bundle.

Parameters

t BundleType - a BundleType.

resources DomainResource[] - array of FHIR resources.

Return Type

Bundle - Return a FHIR Bundle.

createFHIRError

Isolated Function

function createFHIRError(string message, Severity errServerity, IssueType code, string? diagnostic, string[]? expression, error? cause, "TYPE_ERROR"|"PARSE_ERROR"|"SERIALIZATION_ERROR"|"PROCESSING_ERROR"|"VALIDATION_ERROR"? errorType, int httpStatusCode) returns FHIRError

Utility function to create FHIRError.

Parameters

message string - Message to be added to the error

errServerity Severity - serverity of the error

code IssueType - error code

diagnostic string? (default ()) - (optional) diagnostic message

expression string[]? (default ()) - (optional) FHIR Path expression to the error location

cause error? (default ()) - (optional) original error

errorType "TYPE_ERROR"|"PARSE_ERROR"|"SERIALIZATION_ERROR"|"PROCESSING_ERROR"|"VALIDATION_ERROR"? (default ()) - (optional) type of the error

httpStatusCode int (default http:STATUS_INTERNAL_SERVER_ERROR) - (optional) [default: 500] HTTP status code to return to the client

Return Type

FHIRError - Return Value Description

createInternalFHIRError

Isolated Function

function createInternalFHIRError(string message, Severity errServerity, IssueType code, string? diagnostic, string[]? expression, error? cause, "TYPE_ERROR"|"PARSE_ERROR"|"SERIALIZATION_ERROR"|"PROCESSING_ERROR"|"VALIDATION_ERROR"? errorType) returns FHIRError

Utility function to create internal FHIRError.

Parameters

message string - Message to be added to the error

errServerity Severity - serverity of the error

code IssueType - error code

diagnostic string? (default ()) - (optional) diagnostic message

expression string[]? (default ()) - (optional) FHIR Path expression to the error location

cause error? (default ()) - (optional) original error

errorType "TYPE_ERROR"|"PARSE_ERROR"|"SERIALIZATION_ERROR"|"PROCESSING_ERROR"|"VALIDATION_ERROR"? (default ()) - (optional) type of the error

Return Type

FHIRError - Created FHIRError error

createParserErrorFrom

Isolated Function

function createParserErrorFrom(FHIRError fhirError) returns FHIRParseError

Error util function to create FHIR Parser Error from any given FHIR Error.

Parameters

fhirError FHIRError - Source FHIR Error

Return Type

FHIRParseError - Created FHIR Parser Error

dataFilterDataTypeValidationFunction

Isolated Function

function dataFilterDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?

This function validates the data type definition of the ElementDateFilter record.

Parameters

data anydata - data to be validated

elementContextDefinition ElementAnnotationDefinition - element context definition

Return Type

(FHIRValidationError)? - FHIRValidationError array or else nil

dataRequirementDataTypeValidationFunction

Isolated Function

function dataRequirementDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?

This function validates the data type of the DataRequirement element

Parameters

data anydata - Data to be validated

elementContextDefinition ElementAnnotationDefinition - Element context definition

Return Type

(FHIRValidationError)? - FHIRValidationError array if validation fails or else nil

decodeFhirSearchParameters

Isolated Function

function decodeFhirSearchParameters(string urlEncodedParams) returns map<RequestSearchParameter[] & readonly>|FHIRError

Parameters

urlEncodedParams string -

dosageDataTypeValidationFunction

Isolated Function

function dosageDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?

This function validates the dosage data type

Parameters

data anydata - data to be validated

elementContextDefinition ElementAnnotationDefinition - Element context definition

Return Type

(FHIRValidationError)? - FHIRValidationError array if validation fails, else nil

doseAndRateDataTypeValidationFunction

Isolated Function

function doseAndRateDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?

This function validates the data type of the DoseAndRate element

Parameters

data anydata - Data to be validated

elementContextDefinition ElementAnnotationDefinition - Element context definition

Return Type

(FHIRValidationError)? - FHIRValidationError array if validation fails

elementDefinitionDataTypeValidationFunction

Isolated Function

function elementDefinitionDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?

This function validates the data type of the element definition record.

Parameters

data anydata - data to be validated

elementContextDefinition ElementAnnotationDefinition - element definition record

Return Type

(FHIRValidationError)? - error if validation fails

errorToOperationOutcome

Isolated Function

function errorToOperationOutcome(FHIRError fhirError) returns OperationOutcome

Utility function to create OperationOutcome from FHIRError.

Parameters

fhirError FHIRError - FHIRError to be converted

Return Type

OperationOutcome - created OperationOutcome record

executeResourceJsonSerializer

Isolated Function

function executeResourceJsonSerializer(anydata fhirResource) returns (json|FHIRSerializerError)

Serializes a FHIR Resource to a JSON representation

Parameters

fhirResource anydata - FHIR Resource to be serialized

Return Type

(json|FHIRSerializerError) - JSON representation of the data

executeResourceXMLSerializer

Isolated Function

function executeResourceXMLSerializer(anydata fhirResource) returns (xml|FHIRSerializerError)

Serializes a FHIR Resource to a XML representation

Parameters

fhirResource anydata - FHIR Resource to be serialized

Return Type

(xml|FHIRSerializerError) - XML representation of the data

fhirBundleJsonSerializer

Isolated Function

function fhirBundleJsonSerializer(Bundle data) returns (FHIRWireFormat|FHIRSerializerError)?

Parameters

data Bundle -

fhirBundleXmlSerializer

Isolated Function

function fhirBundleXmlSerializer(Bundle data) returns (FHIRWireFormat|FHIRSerializerError)?

Parameters

data Bundle -

fhirResourceJsonSerializer

Isolated Function

function fhirResourceJsonSerializer(anydata data) returns (FHIRWireFormat|FHIRSerializerError)?

Serializes a FHIR Resource to a JSON representation

Parameters

data anydata - data to be serialized

Return Type

(FHIRWireFormat|FHIRSerializerError)? - JSON representation of the data

fhirResourceXMLSerializer

Isolated Function

function fhirResourceXMLSerializer(anydata data) returns (FHIRWireFormat|FHIRSerializerError)?

Serializes a FHIR Resource to a XML representation

Parameters

data anydata - data to be serialized

Return Type

(FHIRWireFormat|FHIRSerializerError)? - XML representation of the data

getErrorCode

Isolated Function

function getErrorCode(error errorResponse) returns int

Parameters

errorResponse error -

getErrorMessage

Isolated Function

function getErrorMessage(ClientRequestError requestError) returns string

Extract error messages from 4xx errors.

Parameters

requestError ClientRequestError - ClientRequestError.

Return Type

string - Error message.

getFHIRContext

Isolated Function

function getFHIRContext(RequestContext httpCtx) returns FHIRContext|FHIRError

Get the FHIR context from the HTTP request context.

Parameters

httpCtx RequestContext - HTTP request context

Return Type

FHIRContext|FHIRError - FHIR context or error

getRequestResourceEntity

Isolated Function

function getRequestResourceEntity(RequestContext ctx) returns FHIRResourceEntity|FHIRError

Get request resource entity from the FHIR context.

Parameters

ctx RequestContext - HTTP request context

Return Type

FHIRResourceEntity|FHIRError - FHIR resource entity or error

handleErrorResponse

Isolated Function

function handleErrorResponse(error errorResponse) returns OperationOutcome

Parameters

errorResponse error -

parse

Isolated Function

function parse(json|xml|string payload, typedesc<anydata>? targetFHIRModelType, string? targetProfile) returns anydata|FHIRParseError

Function to parse FHIR Payload into FHIR Resource model. Note : When using inside FHIR templates, use ballerinax/health.fhir.r4.parser module instead of this.

Parameters

payload json|xml|string - FHIR payload

targetFHIRModelType typedesc<anydata>? (default ()) - (Optional) target model type to parse. Derived from payload if not given

targetProfile string? (default ()) - (Optional) target profile to parse. Derived from payload if not given

Return Type

anydata|FHIRParseError - returns FHIR model (Need to cast to relevant type by the caller). FHIRParseError if error ocurred

populationDataTypeValidationFunction

Isolated Function

function populationDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?

Parameters

data anydata -

elementContextDefinition ElementAnnotationDefinition -

rangeDataTypeValidationFunction

Isolated Function

function rangeDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?

Parameters

data anydata -

elementContextDefinition ElementAnnotationDefinition -

ratioDataTypeValidationFunction

Isolated Function

function ratioDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?

Parameters

data anydata -

elementContextDefinition ElementAnnotationDefinition -

repeatElementDataTypeValidationFunction

Isolated Function

function repeatElementDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?

This function validates the data type of the element

Parameters

data anydata - data to be validated

elementContextDefinition ElementAnnotationDefinition - Element context definition

Return Type

(FHIRValidationError)? - FHIRValidationError array if validation fails, else nil

substanceAmountDataTypeValidationFunction

Isolated Function

function substanceAmountDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?

Parameters

data anydata -

elementContextDefinition ElementAnnotationDefinition -

triggerDefinitionDataTypeValidationFunction

Isolated Function

function triggerDefinitionDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?

Parameters

data anydata -

elementContextDefinition ElementAnnotationDefinition -

urlEncodeFhirSearchParameters

Isolated Function

function urlEncodeFhirSearchParameters(map<RequestSearchParameter[] & readonly> & readonly params) returns string|FHIRError

Parameters

params map<RequestSearchParameter[] & readonly> & readonly -

usageContextDataTypeValidationFunction

Isolated Function

function usageContextDataTypeValidationFunction(anydata data, ElementAnnotationDefinition elementContextDefinition) returns (FHIRValidationError)?

Parameters

data anydata -

elementContextDefinition ElementAnnotationDefinition -

validate

Isolated Function

function validate(json|anydata data, typedesc<anydata>? targetFHIRModelType) returns FHIRValidationError?

This method will validate FHIR resource. Validation consist of Structure, cardinality, Value domain, Profile, json.

Parameters

data json|anydata - FHIR resource (can be in json or anydata)

targetFHIRModelType typedesc<anydata>? (default ()) - (Optional) target model type to validate. Derived from payload if not given

Return Type

FHIRValidationError? - If the validation fails, return validation error

Classes

health.fhir.r4: FHIRContainerResourceEntity

Isolated

Class to wrap FHIR resource

unwrap

Isolated Function

function unwrap() returns anydata

toXml

Isolated Function

function toXml() returns xml|FHIRSerializerError

toJson

Isolated Function

function toJson() returns json|FHIRSerializerError

health.fhir.r4: FHIRContainerResponse

Isolated

Class representing FHIR Container response (Bundle)

getResourceEntity

Isolated Function

function getResourceEntity() returns FHIRContainerResourceEntity

health.fhir.r4: FHIRContext

Isolated

FHIR Context class: used to transfer FHIR request related information down integration flow

getDirection

Isolated Function

function getDirection() returns MessageDirection

Get context direction : indicate whether the request is in request direction or response direction.

Return Type

MessageDirection - Message direction

isInErrorState

Isolated Function

function isInErrorState() returns boolean

Set error state : indicate whether the request is in error state or not.

Return Type

boolean - whether the request is in error state or not.

setInErrorState

Isolated Function

function setInErrorState(boolean inErrorState)

Set error state : indicate whether the request is in error state or not.

Parameters

inErrorState boolean - whether the request is in error state or not.

setErrorCode

Isolated Function

function setErrorCode(int errorCode)

Get error code : error code of the request, if in error.

Parameters

errorCode int - error code of the request, if in error.

getErrorCode

Isolated Function

function getErrorCode() returns int

Get error code : error code of the request, if in error.

Return Type

int - error code of the request, if in error.

getFHIRRequest

Isolated Function

function getFHIRRequest() returns FHIRRequest?

Get FHIR request. FHIR request parsed information about incoming FHIR request from the client application.

Return Type

FHIRRequest? - FHIR request object

getFHIRSecurity

Isolated Function

function getFHIRSecurity() returns FHIRSecurity?

Get FHIR security information. FHIR request derived security information about incoming FHIR request from the client application.

Return Type

FHIRSecurity? - FHIR security record

getHTTPRequest

Isolated Function

function getHTTPRequest() returns HTTPRequest?

Get incoming raw HTTP request information.

Return Type

HTTPRequest? - Incoming HTTP request

getFHIRResponse

Isolated Function

function getFHIRResponse() returns FHIRResponse|FHIRContainerResponse?

Get FHIR response.

Return Type

FHIRResponse|FHIRContainerResponse? - FHIR response

getInteraction

Isolated Function

function getInteraction() returns FHIRInteraction

Get FHIR interaction information parsed from the incoming FHIR request. http://hl7.org/fhir/http.html#3.1.0.

Return Type

FHIRInteraction - FHIR interaction record

getResourceType

Isolated Function

function getResourceType() returns string?

Get target FHIR resource type.

Return Type

string? - FHIR resource type

getClientAcceptFormat

Isolated Function

function getClientAcceptFormat() returns FHIRPayloadFormat

Get client accepted response format.

Return Type

FHIRPayloadFormat - Client accepted FHIR payload format

getFHIRUser

Isolated Function

function getFHIRUser() returns readonly & FHIRUser?

Get FHIR User : End user information available in the JWT.

Return Type

readonly & FHIRUser? - FHIR Usr information

getRequestSearchParameters

Isolated Function

function getRequestSearchParameters() returns readonly & map<readonly & RequestSearchParameter[]>

Get all request parameters.

Return Type

readonly & map<readonly & RequestSearchParameter[]> - Request search parameter map (Key of the map is name of the search parameter).

getRequestSearchParameter

Isolated Function

function getRequestSearchParameter(string name) returns readonly & RequestSearchParameter[]?

Get search parameter with given name.

Parameters

name string - Name of the search parameter

Return Type

readonly & RequestSearchParameter[]? - Request search parameter array if available. Otherwise nil

getNumberSearchParameter

Isolated Function

function getNumberSearchParameter(string name) returns NumberSearchParameter[]|FHIRTypeError?

Function to get Number typed search parameter with given name from the FHIR API request.

Parameters

name string - Name of the search parameter

Return Type

NumberSearchParameter[]|FHIRTypeError? - Search parameter if exists, nil if not found and FHIRTypeError if search parameter is not Number type

getReferenceSearchParameter

Isolated Function

function getReferenceSearchParameter(string name) returns ReferenceSearchParameter[]|FHIRTypeError?

Function to get Reference typed search parameter with given name from the FHIR API request.

Parameters

name string - Name of the search parameter

Return Type

ReferenceSearchParameter[]|FHIRTypeError? - Search parameter if exists, nil if not found and FHIRTypeError if search parameter is not Reference type

getStringSearchParameter

Isolated Function

function getStringSearchParameter(string name) returns StringSearchParameter[]|FHIRTypeError?

Function to get String typed search parameter with given name from the FHIR API request.

Parameters

name string - Name of the search parameter

Return Type

StringSearchParameter[]|FHIRTypeError? - Search parameter if exists, nil if not found and FHIRTypeError if search parameter is not String type

getTokenSearchParameter

Isolated Function

function getTokenSearchParameter(string name) returns TokenSearchParameter[]|FHIRTypeError?

Function to get Token typed search parameter with given name from the FHIR API request.

Parameters

name string - Name of the search parameter

Return Type

TokenSearchParameter[]|FHIRTypeError? - Search parameter if exists, nil if not found and FHIRTypeError if search parameter is not Token type

getURISearchParameter

Isolated Function

function getURISearchParameter(string name) returns URISearchParameter[]|FHIRTypeError?

Function to get URI typed search parameter with given name from the FHIR API request.

Parameters

name string - Name of the search parameter

Return Type

URISearchParameter[]|FHIRTypeError? - Search parameter if exists, nil if not found and FHIRTypeError if search parameter is not URI type

getDateSearchParameter

Isolated Function

function getDateSearchParameter(string name) returns DateSearchParameter[]|FHIRTypeError?

Function to get Date typed search parameter with given name from the FHIR API request.

Parameters

name string - Name of the search parameter

Return Type

DateSearchParameter[]|FHIRTypeError? - Search parameter if exists, nil if not found and FHIRTypeError if search parameter is not Date type

getQuantitySearchParameter

Isolated Function

function getQuantitySearchParameter(string name) returns QuantitySearchParameter[]|FHIRTypeError?

Function to get Quantity typed search parameter with given name from the FHIR API request.

Parameters

name string - Name of the search parameter

Return Type

QuantitySearchParameter[]|FHIRTypeError? - Search parameter if exists, nil if not found and FHIRTypeError if search parameter is not Quantity type

getCompositeSearchParameter

Isolated Function

function getCompositeSearchParameter(string name) returns CompositeSearchParameter[]|FHIRTypeError?

Function to get Composite typed search parameter with given name from the FHIR API request.

Parameters

name string - Name of the search parameter

Return Type

CompositeSearchParameter[]|FHIRTypeError? - Search parameter if exists, nil if not found and FHIRTypeError if search parameter is not Composite type

getSpecialSearchParameter

Isolated Function

function getSpecialSearchParameter(string name) returns SpecialSearchParameter[]|FHIRTypeError?

Function to get Special typed search parameter with given name from the FHIR API request.

Parameters

name string - Name of the search parameter

Return Type

SpecialSearchParameter[]|FHIRTypeError? - Search parameter if exists, nill if not found and FHIRTypeError if search parameter is not Special type

health.fhir.r4: FHIRImplementationGuide

Isolated

Represents FHIR Implementation Guide holding information and functionalities bound to it

getName

Isolated Function

function getName() returns string

getTerminology

Isolated Function

function getTerminology() returns Terminology

getProfiles

Isolated Function

function getProfiles() returns map<Profile>

getSearchParameters

Isolated Function

function getSearchParameters() returns map<FHIRSearchParameterDefinition[]>[]

health.fhir.r4: FHIRPreprocessor

Isolated

FHIR Pre-processor implementation.

Constructor

Initialize the FHIR pre-processor

init (ResourceAPIConfig apiConfig)

apiConfig ResourceAPIConfig - The API configuration

processRead

Isolated Function

function processRead(string fhirResourceType, string id, Request httpRequest, RequestContext httpCtx) returns FHIRError?

Process the FHIR Read interaction.

Parameters

fhirResourceType string - The FHIR resource type

id string - The FHIR resource id

httpRequest Request - The HTTP request

httpCtx RequestContext - The HTTP request context

Return Type

FHIRError? - The next service or an error

processSearch

Isolated Function

function processSearch(string fhirResourceType, Request httpRequest, RequestContext httpCtx) returns FHIRError?

Process the FHIR Search interaction.

Parameters

fhirResourceType string - The FHIR resource type

httpRequest Request - The HTTP request

httpCtx RequestContext - The HTTP request context

Return Type

FHIRError? - The next service or an error

processCreate

Isolated Function

function processCreate(string resourceType, json|xml payload, Request httpRequest, RequestContext httpCtx) returns FHIRError?

Process the FHIR Create interaction.

Parameters

resourceType string - The FHIR resource type

payload json|xml - The payload

httpRequest Request - The HTTP request

httpCtx RequestContext - The HTTP request context

Return Type

FHIRError? - The next service or an error

health.fhir.r4: FHIRRegistry

Isolated

Hold FHIR related information in a particular deployment

addImplementationGuide

function addImplementationGuide(FHIRImplementationGuide ig) returns FHIRError?

Add an implementation guide to the registry

Parameters

ig FHIRImplementationGuide - The implementation guide to be added

Return Type

FHIRError? - An error if the implementation guide is invalid or an error occurred while adding the implementation guide

getResourceProfiles

Isolated Function

function getResourceProfiles(string resourceType) returns readonly & map<Profile & readonly>

Get the resource profiles in the registry

Parameters

resourceType string - The resource type

Return Type

readonly & map<Profile & readonly> - The profiles in the registry

getResourceSearchParameters

Isolated Function

function getResourceSearchParameters(string resourceType) returns SearchParamCollection

Get the resource search parameters in the registry

Parameters

resourceType string - The resource type

Return Type

SearchParamCollection - The search parameters in the registry

getResourceSearchParameterByName

Isolated Function

function getResourceSearchParameterByName(string resourceType, string name) returns FHIRSearchParameterDefinition?

Get the search parameters in the registry by name

Parameters

resourceType string - The resource type

name string - The name of the search parameter

Return Type

FHIRSearchParameterDefinition? - The search parameters in the registry

findProfile

Isolated Function

function findProfile(string url) returns (readonly & Profile)?

Get the profiles in the registry

Parameters

url string - The url of the profile

Return Type

(readonly & Profile)? - The profiles in the registry

findBaseProfile

Isolated Function

function findBaseProfile(string resourceType) returns (readonly & Profile)?

Get the base profiles in the registry

Parameters

resourceType string - The resource type

Return Type

(readonly & Profile)? - The base profile in the registry

isSupportedResource

Isolated Function

function isSupportedResource(string resourceType) returns boolean

Check the resource type is supported by the registry

Parameters

resourceType string - The resource type

Return Type

boolean - True if the resource type is supported

health.fhir.r4: FHIRRequest

Isolated

Class representing FHIR request

getResourceEntity

Isolated Function

function getResourceEntity() returns FHIRResourceEntity?

getSearchParameters

Isolated Function

function getSearchParameters() returns readonly & map<readonly & RequestSearchParameter[]>

getClientAcceptFormat

Isolated Function

function getClientAcceptFormat() returns FHIRPayloadFormat

getResourceType

Isolated Function

function getResourceType() returns string?

getInteraction

Isolated Function

function getInteraction() returns readonly & FHIRInteraction

health.fhir.r4: FHIRResourceEntity

Isolated

Class to wrap FHIR resource

unwrap

Isolated Function

function unwrap() returns anydata

toXml

Isolated Function

function toXml() returns xml|FHIRSerializerError

toJson

Isolated Function

function toJson() returns json|FHIRSerializerError

health.fhir.r4: FHIRResponse

Isolated

Class representing FHIR response

getResourceEntity

Isolated Function

function getResourceEntity() returns FHIRResourceEntity

health.fhir.r4: FHIRResponseErrorInterceptor

Isolated

Response error interceptor to handle errors thrown by fhir preproccessors

interceptResponseError

Isolated FunctionRemote Function

function interceptResponseError(error err) returns NotFound|BadRequest|UnsupportedMediaType|NotAcceptable|Unauthorized|NotImplemented|InternalServerError

Parameters

err error -

health.fhir.r4: FHIRResponseInterceptor

Isolated

Response error interceptor to post-process FHIR responses

interceptResponse

Isolated FunctionRemote Function

function interceptResponse(RequestContext ctx, Response res) returns NextService|FHIRError?

Parameters

ctx RequestContext -

res Response -

health.fhir.r4: InMemoryTerminologyLoader

An in-memory implementation of a terminology loader

load

function load() returns Terminology|FHIRError

load terminology

Return Type

Terminology|FHIRError - Terminology populated

health.fhir.r4: TerminologyProcessor

A processor to process terminology data and create relevent data elements

addTerminology

function addTerminology(Terminology terminology)

Parameters

terminology Terminology -

addCodeSystems

function addCodeSystems(CodeSystem[] codeSystems)

Parameters

codeSystems CodeSystem[] -

addValueSets

function addValueSets(ValueSet[] valueSets)

Parameters

valueSets ValueSet[] -

createCodeableConcept

Isolated Function

function createCodeableConcept(uri system, code code, CodeSystemFinder? codeSystemFinder) returns CodeableConcept|FHIRError

Create CodeableConcept for given code in a given system.

Parameters

system uri - system uri of the code system or value set

code code - code interested

codeSystemFinder CodeSystemFinder? (default ()) - (optional) custom code system function (utility will used this function to find code system in a external source system)

Return Type

CodeableConcept|FHIRError - Created CodeableConcept record or FHIRError if not found

createCoding

Isolated Function

function createCoding(uri system, code code, CodeSystemFinder? codeSystemFinder) returns Coding|FHIRError

Create Coding for given code in a given system.

Parameters

system uri - system uri of the code system or value set

code code - code interested

codeSystemFinder CodeSystemFinder? (default ()) - (optional) custom code system function (utility will used this function to find code system in a external source system)

Return Type

Coding|FHIRError - Created CodeableConcept record or FHIRError if not found

Constants

health.fhir.r4: FHIR_BASE_IG

string "international"

This is the FHIR base IG name

health.fhir.r4: FHIR_CONTEXT_PROP_NAME

string "_OH_FHIR_REQUEST_CONTEXT_"

This is the FHIR request context property name

health.fhir.r4: FHIR_MIME_TYPE_JSON

string "application/fhir+json"

This is the FHIR MIME type FHIR+JSON

health.fhir.r4: FHIR_MIME_TYPE_XML

string "application/fhir+xml"

This is the FHIR MIME type FHIR+XML

health.fhir.r4: FHIR_NAMESPACE

string "http://hl7.org/fhir"

This is the default FHIR XML namespace

health.fhir.r4: FHIR_SEARCH_PARAM_PROFILE

string "_profile"

This is the FHIR common search parameter for profile

health.fhir.r4: PROFILE_BASE_ACCOUNT

string "http://hl7.org/fhir/StructureDefinition/Account"

health.fhir.r4: PROFILE_BASE_ACTIVITYDEFINITION

string "http://hl7.org/fhir/StructureDefinition/ActivityDefinition"

health.fhir.r4: PROFILE_BASE_ADVERSEEVENT

string "http://hl7.org/fhir/StructureDefinition/AdverseEvent"

health.fhir.r4: PROFILE_BASE_ALLERGYINTOLERANCE

string "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance"

health.fhir.r4: PROFILE_BASE_APPOINTMENT

string "http://hl7.org/fhir/StructureDefinition/Appointment"

health.fhir.r4: PROFILE_BASE_APPOINTMENTRESPONSE

string "http://hl7.org/fhir/StructureDefinition/AppointmentResponse"

health.fhir.r4: PROFILE_BASE_AUDITEVENT

string "http://hl7.org/fhir/StructureDefinition/AuditEvent"

health.fhir.r4: PROFILE_BASE_BASIC

string "http://hl7.org/fhir/StructureDefinition/Basic"

health.fhir.r4: PROFILE_BASE_BINARY

string "http://hl7.org/fhir/StructureDefinition/Binary"

health.fhir.r4: PROFILE_BASE_BIOLOGICALLYDERIVEDPRODUCT

string "http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProduct"

health.fhir.r4: PROFILE_BASE_BODYSTRUCTURE

string "http://hl7.org/fhir/StructureDefinition/BodyStructure"

health.fhir.r4: PROFILE_BASE_BUNDLE

string "http://hl7.org/fhir/StructureDefinition/Bundle"

health.fhir.r4: PROFILE_BASE_CAPABILITYSTATEMENT

string "http://hl7.org/fhir/StructureDefinition/CapabilityStatement"

health.fhir.r4: PROFILE_BASE_CAREPLAN

string "http://hl7.org/fhir/StructureDefinition/CarePlan"

health.fhir.r4: PROFILE_BASE_CARETEAM

string "http://hl7.org/fhir/StructureDefinition/CareTeam"

health.fhir.r4: PROFILE_BASE_CATALOGENTRY

string "http://hl7.org/fhir/StructureDefinition/CatalogEntry"

health.fhir.r4: PROFILE_BASE_CHARGEITEM

string "http://hl7.org/fhir/StructureDefinition/ChargeItem"

health.fhir.r4: PROFILE_BASE_CHARGEITEMDEFINITION

string "http://hl7.org/fhir/StructureDefinition/ChargeItemDefinition"

health.fhir.r4: PROFILE_BASE_CLAIM

string "http://hl7.org/fhir/StructureDefinition/Claim"

health.fhir.r4: PROFILE_BASE_CLAIMRESPONSE

string "http://hl7.org/fhir/StructureDefinition/ClaimResponse"

health.fhir.r4: PROFILE_BASE_CLINICALIMPRESSION

string "http://hl7.org/fhir/StructureDefinition/ClinicalImpression"

health.fhir.r4: PROFILE_BASE_CODESYSTEM

string "http://hl7.org/fhir/StructureDefinition/CodeSystem"

health.fhir.r4: PROFILE_BASE_COMMUNICATION

string "http://hl7.org/fhir/StructureDefinition/Communication"

health.fhir.r4: PROFILE_BASE_COMMUNICATIONREQUEST

string "http://hl7.org/fhir/StructureDefinition/CommunicationRequest"

health.fhir.r4: PROFILE_BASE_COMPARTMENTDEFINITION

string "http://hl7.org/fhir/StructureDefinition/CompartmentDefinition"

health.fhir.r4: PROFILE_BASE_COMPOSITION

string "http://hl7.org/fhir/StructureDefinition/Composition"

health.fhir.r4: PROFILE_BASE_CONCEPTMAP

string "http://hl7.org/fhir/StructureDefinition/ConceptMap"

health.fhir.r4: PROFILE_BASE_CONDITION

string "http://hl7.org/fhir/StructureDefinition/Condition"

health.fhir.r4: PROFILE_BASE_CONSENT

string "http://hl7.org/fhir/StructureDefinition/Consent"

health.fhir.r4: PROFILE_BASE_CONTRACT

string "http://hl7.org/fhir/StructureDefinition/Contract"

health.fhir.r4: PROFILE_BASE_COVERAGE

string "http://hl7.org/fhir/StructureDefinition/Coverage"

health.fhir.r4: PROFILE_BASE_COVERAGEELIGIBILITYREQUEST

string "http://hl7.org/fhir/StructureDefinition/CoverageEligibilityRequest"

health.fhir.r4: PROFILE_BASE_COVERAGEELIGIBILITYRESPONSE

string "http://hl7.org/fhir/StructureDefinition/CoverageEligibilityResponse"

health.fhir.r4: PROFILE_BASE_DETECTEDISSUE

string "http://hl7.org/fhir/StructureDefinition/DetectedIssue"

health.fhir.r4: PROFILE_BASE_DEVICE

string "http://hl7.org/fhir/StructureDefinition/Device"

health.fhir.r4: PROFILE_BASE_DEVICEDEFINITION

string "http://hl7.org/fhir/StructureDefinition/DeviceDefinition"

health.fhir.r4: PROFILE_BASE_DEVICEMETRIC

string "http://hl7.org/fhir/StructureDefinition/DeviceMetric"

health.fhir.r4: PROFILE_BASE_DEVICEREQUEST

string "http://hl7.org/fhir/StructureDefinition/DeviceRequest"

health.fhir.r4: PROFILE_BASE_DEVICEUSESTATEMENT

string "http://hl7.org/fhir/StructureDefinition/DeviceUseStatement"

health.fhir.r4: PROFILE_BASE_DIAGNOSTICREPORT

string "http://hl7.org/fhir/StructureDefinition/DiagnosticReport"

health.fhir.r4: PROFILE_BASE_DOCUMENTMANIFEST

string "http://hl7.org/fhir/StructureDefinition/DocumentManifest"

health.fhir.r4: PROFILE_BASE_DOCUMENTREFERENCE

string "http://hl7.org/fhir/StructureDefinition/DocumentReference"

health.fhir.r4: PROFILE_BASE_EFFECTEVIDENCESYNTHESIS

string "http://hl7.org/fhir/StructureDefinition/EffectEvidenceSynthesis"

health.fhir.r4: PROFILE_BASE_ENCOUNTER

string "http://hl7.org/fhir/StructureDefinition/Encounter"

health.fhir.r4: PROFILE_BASE_ENDPOINT

string "http://hl7.org/fhir/StructureDefinition/Endpoint"

health.fhir.r4: PROFILE_BASE_ENROLLMENTREQUEST

string "http://hl7.org/fhir/StructureDefinition/EnrollmentRequest"

health.fhir.r4: PROFILE_BASE_ENROLLMENTRESPONSE

string "http://hl7.org/fhir/StructureDefinition/EnrollmentResponse"

health.fhir.r4: PROFILE_BASE_EPISODEOFCARE

string "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"

health.fhir.r4: PROFILE_BASE_EVENTDEFINITION

string "http://hl7.org/fhir/StructureDefinition/EventDefinition"

health.fhir.r4: PROFILE_BASE_EVIDENCE

string "http://hl7.org/fhir/StructureDefinition/Evidence"

health.fhir.r4: PROFILE_BASE_EVIDENCEVARIABLE

string "http://hl7.org/fhir/StructureDefinition/EvidenceVariable"

health.fhir.r4: PROFILE_BASE_EXAMPLESCENARIO

string "http://hl7.org/fhir/StructureDefinition/ExampleScenario"

health.fhir.r4: PROFILE_BASE_EXPLANATIONOFBENEFIT

string "http://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit"

health.fhir.r4: PROFILE_BASE_FAMILYMEMBERHISTORY

string "http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory"

health.fhir.r4: PROFILE_BASE_FLAG

string "http://hl7.org/fhir/StructureDefinition/Flag"

health.fhir.r4: PROFILE_BASE_GOAL

string "http://hl7.org/fhir/StructureDefinition/Goal"

health.fhir.r4: PROFILE_BASE_GRAPHDEFINITION

string "http://hl7.org/fhir/StructureDefinition/GraphDefinition"

health.fhir.r4: PROFILE_BASE_GROUP

string "http://hl7.org/fhir/StructureDefinition/Group"

health.fhir.r4: PROFILE_BASE_GUIDANCERESPONSE

string "http://hl7.org/fhir/StructureDefinition/GuidanceResponse"

health.fhir.r4: PROFILE_BASE_HEALTHCARESERVICE

string "http://hl7.org/fhir/StructureDefinition/HealthcareService"

health.fhir.r4: PROFILE_BASE_IMAGINGSTUDY

string "http://hl7.org/fhir/StructureDefinition/ImagingStudy"

health.fhir.r4: PROFILE_BASE_IMMUNIZATION

string "http://hl7.org/fhir/StructureDefinition/Immunization"

health.fhir.r4: PROFILE_BASE_IMMUNIZATIONEVALUATION

string "http://hl7.org/fhir/StructureDefinition/ImmunizationEvaluation"

health.fhir.r4: PROFILE_BASE_IMMUNIZATIONRECOMMENDATION

string "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"

health.fhir.r4: PROFILE_BASE_IMPLEMENTATIONGUIDE

string "http://hl7.org/fhir/StructureDefinition/ImplementationGuide"

health.fhir.r4: PROFILE_BASE_INSURANCEPLAN

string "http://hl7.org/fhir/StructureDefinition/InsurancePlan"

health.fhir.r4: PROFILE_BASE_INVOICE

string "http://hl7.org/fhir/StructureDefinition/Invoice"

health.fhir.r4: PROFILE_BASE_LIBRARY

string "http://hl7.org/fhir/StructureDefinition/Library"

health.fhir.r4: PROFILE_BASE_LINKAGE

string "http://hl7.org/fhir/StructureDefinition/Linkage"

health.fhir.r4: PROFILE_BASE_LIST

string "http://hl7.org/fhir/StructureDefinition/List"

health.fhir.r4: PROFILE_BASE_LOCATION

string "http://hl7.org/fhir/StructureDefinition/Location"

health.fhir.r4: PROFILE_BASE_MEASURE

string "http://hl7.org/fhir/StructureDefinition/Measure"

health.fhir.r4: PROFILE_BASE_MEASUREREPORT

string "http://hl7.org/fhir/StructureDefinition/MeasureReport"

health.fhir.r4: PROFILE_BASE_MEDIA

string "http://hl7.org/fhir/StructureDefinition/Media"

health.fhir.r4: PROFILE_BASE_MEDICATION

string "http://hl7.org/fhir/StructureDefinition/Medication"

health.fhir.r4: PROFILE_BASE_MEDICATIONADMINISTRATION

string "http://hl7.org/fhir/StructureDefinition/MedicationAdministration"

health.fhir.r4: PROFILE_BASE_MEDICATIONDISPENSE

string "http://hl7.org/fhir/StructureDefinition/MedicationDispense"

health.fhir.r4: PROFILE_BASE_MEDICATIONKNOWLEDGE

string "http://hl7.org/fhir/StructureDefinition/MedicationKnowledge"

health.fhir.r4: PROFILE_BASE_MEDICATIONREQUEST

string "http://hl7.org/fhir/StructureDefinition/MedicationRequest"

health.fhir.r4: PROFILE_BASE_MEDICATIONSTATEMENT

string "http://hl7.org/fhir/StructureDefinition/MedicationStatement"

health.fhir.r4: PROFILE_BASE_MEDICINALPRODUCT

string "http://hl7.org/fhir/StructureDefinition/MedicinalProduct"

health.fhir.r4: PROFILE_BASE_MEDICINALPRODUCTAUTHORIZATION

string "http://hl7.org/fhir/StructureDefinition/MedicinalProductAuthorization"

health.fhir.r4: PROFILE_BASE_MEDICINALPRODUCTCONTRAINDICATION

string "http://hl7.org/fhir/StructureDefinition/MedicinalProductContraindication"

health.fhir.r4: PROFILE_BASE_MEDICINALPRODUCTINDICATION

string "http://hl7.org/fhir/StructureDefinition/MedicinalProductIndication"

health.fhir.r4: PROFILE_BASE_MEDICINALPRODUCTINGREDIENT

string "http://hl7.org/fhir/StructureDefinition/MedicinalProductIngredient"

health.fhir.r4: PROFILE_BASE_MEDICINALPRODUCTINTERACTION

string "http://hl7.org/fhir/StructureDefinition/MedicinalProductInteraction"

health.fhir.r4: PROFILE_BASE_MEDICINALPRODUCTMANUFACTURED

string "http://hl7.org/fhir/StructureDefinition/MedicinalProductManufactured"

health.fhir.r4: PROFILE_BASE_MEDICINALPRODUCTPACKAGED

string "http://hl7.org/fhir/StructureDefinition/MedicinalProductPackaged"

health.fhir.r4: PROFILE_BASE_MEDICINALPRODUCTPHARMACEUTICAL

string "http://hl7.org/fhir/StructureDefinition/MedicinalProductPharmaceutical"

health.fhir.r4: PROFILE_BASE_MEDICINALPRODUCTUNDESIRABLEEFFECT

string "http://hl7.org/fhir/StructureDefinition/MedicinalProductUndesirableEffect"

health.fhir.r4: PROFILE_BASE_MESSAGEDEFINITION

string "http://hl7.org/fhir/StructureDefinition/MessageDefinition"

health.fhir.r4: PROFILE_BASE_MESSAGEHEADER

string "http://hl7.org/fhir/StructureDefinition/MessageHeader"

health.fhir.r4: PROFILE_BASE_MOLECULARSEQUENCE

string "http://hl7.org/fhir/StructureDefinition/MolecularSequence"

health.fhir.r4: PROFILE_BASE_NAMINGSYSTEM

string "http://hl7.org/fhir/StructureDefinition/NamingSystem"

health.fhir.r4: PROFILE_BASE_NUTRITIONORDER

string "http://hl7.org/fhir/StructureDefinition/NutritionOrder"

health.fhir.r4: PROFILE_BASE_OBSERVATION

string "http://hl7.org/fhir/StructureDefinition/Observation"

health.fhir.r4: PROFILE_BASE_OBSERVATION_VITALSIGNS

string "http://hl7.org/fhir/StructureDefinition/vitalsigns"

health.fhir.r4: PROFILE_BASE_OBSERVATIONDEFINITION

string "http://hl7.org/fhir/StructureDefinition/ObservationDefinition"

health.fhir.r4: PROFILE_BASE_OPERATIONDEFINITION

string "http://hl7.org/fhir/StructureDefinition/OperationDefinition"

health.fhir.r4: PROFILE_BASE_OPERATIONOUTCOME

string "http://hl7.org/fhir/StructureDefinition/OperationOutcome"

health.fhir.r4: PROFILE_BASE_ORGANIZATION

string "http://hl7.org/fhir/StructureDefinition/Organization"

health.fhir.r4: PROFILE_BASE_ORGANIZATIONAFFILIATION

string "http://hl7.org/fhir/StructureDefinition/OrganizationAffiliation"

health.fhir.r4: PROFILE_BASE_PARAMETERS

string "http://hl7.org/fhir/StructureDefinition/Parameters"

health.fhir.r4: PROFILE_BASE_PATIENT

string "http://hl7.org/fhir/StructureDefinition/Patient"

health.fhir.r4: PROFILE_BASE_PAYMENTNOTICE

string "http://hl7.org/fhir/StructureDefinition/PaymentNotice"

health.fhir.r4: PROFILE_BASE_PAYMENTRECONCILIATION

string "http://hl7.org/fhir/StructureDefinition/PaymentReconciliation"

health.fhir.r4: PROFILE_BASE_PERSON

string "http://hl7.org/fhir/StructureDefinition/Person"

health.fhir.r4: PROFILE_BASE_PLANDEFINITION

string "http://hl7.org/fhir/StructureDefinition/PlanDefinition"

health.fhir.r4: PROFILE_BASE_PRACTITIONER

string "http://hl7.org/fhir/StructureDefinition/Practitioner"

health.fhir.r4: PROFILE_BASE_PRACTITIONERROLE

string "http://hl7.org/fhir/StructureDefinition/PractitionerRole"

health.fhir.r4: PROFILE_BASE_PROCEDURE

string "http://hl7.org/fhir/StructureDefinition/Procedure"

health.fhir.r4: PROFILE_BASE_PROVENANCE

string "http://hl7.org/fhir/StructureDefinition/Provenance"

health.fhir.r4: PROFILE_BASE_QUESTIONNAIRE

string "http://hl7.org/fhir/StructureDefinition/Questionnaire"

health.fhir.r4: PROFILE_BASE_QUESTIONNAIRERESPONSE

string "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse"

health.fhir.r4: PROFILE_BASE_RELATEDPERSON

string "http://hl7.org/fhir/StructureDefinition/RelatedPerson"

health.fhir.r4: PROFILE_BASE_REQUESTGROUP

string "http://hl7.org/fhir/StructureDefinition/RequestGroup"

health.fhir.r4: PROFILE_BASE_RESEARCHDEFINITION

string "http://hl7.org/fhir/StructureDefinition/ResearchDefinition"

health.fhir.r4: PROFILE_BASE_RESEARCHELEMENTDEFINITION

string "http://hl7.org/fhir/StructureDefinition/ResearchElementDefinition"

health.fhir.r4: PROFILE_BASE_RESEARCHSTUDY

string "http://hl7.org/fhir/StructureDefinition/ResearchStudy"

health.fhir.r4: PROFILE_BASE_RESEARCHSUBJECT

string "http://hl7.org/fhir/StructureDefinition/ResearchSubject"

health.fhir.r4: PROFILE_BASE_RISKASSESSMENT

string "http://hl7.org/fhir/StructureDefinition/RiskAssessment"

health.fhir.r4: PROFILE_BASE_RISKEVIDENCESYNTHESIS

string "http://hl7.org/fhir/StructureDefinition/RiskEvidenceSynthesis"

health.fhir.r4: PROFILE_BASE_SCHEDULE

string "http://hl7.org/fhir/StructureDefinition/Schedule"

health.fhir.r4: PROFILE_BASE_SEARCHPARAMETER

string "http://hl7.org/fhir/StructureDefinition/SearchParameter"

health.fhir.r4: PROFILE_BASE_SERVICEREQUEST

string "http://hl7.org/fhir/StructureDefinition/ServiceRequest"

health.fhir.r4: PROFILE_BASE_SLOT

string "http://hl7.org/fhir/StructureDefinition/Slot"

health.fhir.r4: PROFILE_BASE_SPECIMEN

string "http://hl7.org/fhir/StructureDefinition/Specimen"

health.fhir.r4: PROFILE_BASE_SPECIMENDEFINITION

string "http://hl7.org/fhir/StructureDefinition/SpecimenDefinition"

health.fhir.r4: PROFILE_BASE_STRUCTUREDEFINITION

string "http://hl7.org/fhir/StructureDefinition/StructureDefinition"

health.fhir.r4: PROFILE_BASE_STRUCTUREMAP

string "http://hl7.org/fhir/StructureDefinition/StructureMap"

health.fhir.r4: PROFILE_BASE_SUBSCRIPTION

string "http://hl7.org/fhir/StructureDefinition/Subscription"

health.fhir.r4: PROFILE_BASE_SUBSTANCE

string "http://hl7.org/fhir/StructureDefinition/Substance"

health.fhir.r4: PROFILE_BASE_SUBSTANCENUCLEICACID

string "http://hl7.org/fhir/StructureDefinition/SubstanceNucleicAcid"

health.fhir.r4: PROFILE_BASE_SUBSTANCEPOLYMER

string "http://hl7.org/fhir/StructureDefinition/SubstancePolymer"

health.fhir.r4: PROFILE_BASE_SUBSTANCEPROTEIN

string "http://hl7.org/fhir/StructureDefinition/SubstanceProtein"

health.fhir.r4: PROFILE_BASE_SUBSTANCEREFERENCEINFORMATION

string "http://hl7.org/fhir/StructureDefinition/SubstanceReferenceInformation"

health.fhir.r4: PROFILE_BASE_SUBSTANCESOURCEMATERIAL

string "http://hl7.org/fhir/StructureDefinition/SubstanceSourceMaterial"

health.fhir.r4: PROFILE_BASE_SUBSTANCESPECIFICATION

string "http://hl7.org/fhir/StructureDefinition/SubstanceSpecification"

health.fhir.r4: PROFILE_BASE_SUPPLYDELIVERY

string "http://hl7.org/fhir/StructureDefinition/SupplyDelivery"

health.fhir.r4: PROFILE_BASE_SUPPLYREQUEST

string "http://hl7.org/fhir/StructureDefinition/SupplyRequest"

health.fhir.r4: PROFILE_BASE_TASK

string "http://hl7.org/fhir/StructureDefinition/Task"

health.fhir.r4: PROFILE_BASE_TERMINOLOGYCAPABILITIES

string "http://hl7.org/fhir/StructureDefinition/TerminologyCapabilities"

health.fhir.r4: PROFILE_BASE_TESTREPORT

string "http://hl7.org/fhir/StructureDefinition/TestReport"

health.fhir.r4: PROFILE_BASE_TESTSCRIPT

string "http://hl7.org/fhir/StructureDefinition/TestScript"

health.fhir.r4: PROFILE_BASE_VALUESET

string "http://hl7.org/fhir/StructureDefinition/ValueSet"

health.fhir.r4: PROFILE_BASE_VERIFICATIONRESULT

string "http://hl7.org/fhir/StructureDefinition/VerificationResult"

health.fhir.r4: PROFILE_BASE_VISIONPRESCRIPTION

string "http://hl7.org/fhir/StructureDefinition/VisionPrescription"

health.fhir.r4: RESOURCE_NAME_ACCOUNT

string "Account"

health.fhir.r4: RESOURCE_NAME_ACTIVITYDEFINITION

string "ActivityDefinition"

health.fhir.r4: RESOURCE_NAME_ADVERSEEVENT

string "AdverseEvent"

health.fhir.r4: RESOURCE_NAME_ALLERGYINTOLERANCE

string "AllergyIntolerance"

health.fhir.r4: RESOURCE_NAME_APPOINTMENT

string "Appointment"

health.fhir.r4: RESOURCE_NAME_APPOINTMENTRESPONSE

string "AppointmentResponse"

health.fhir.r4: RESOURCE_NAME_AUDITEVENT

string "AuditEvent"

health.fhir.r4: RESOURCE_NAME_BASIC

string "Basic"

health.fhir.r4: RESOURCE_NAME_BINARY

string "Binary"

health.fhir.r4: RESOURCE_NAME_BIOLOGICALLYDERIVEDPRODUCT

string "BiologicallyDerivedProduct"

health.fhir.r4: RESOURCE_NAME_BODYSTRUCTURE

string "BodyStructure"

health.fhir.r4: RESOURCE_NAME_BUNDLE

string "Bundle"

health.fhir.r4: RESOURCE_NAME_CAPABILITYSTATEMENT

string "CapabilityStatement"

health.fhir.r4: RESOURCE_NAME_CAREPLAN

string "CarePlan"

health.fhir.r4: RESOURCE_NAME_CARETEAM

string "CareTeam"

health.fhir.r4: RESOURCE_NAME_CATALOGENTRY

string "CatalogEntry"

health.fhir.r4: RESOURCE_NAME_CHARGEITEM

string "ChargeItem"

health.fhir.r4: RESOURCE_NAME_CHARGEITEMDEFINITION

string "ChargeItemDefinition"

health.fhir.r4: RESOURCE_NAME_CLAIM

string "Claim"

health.fhir.r4: RESOURCE_NAME_CLAIMRESPONSE

string "ClaimResponse"

health.fhir.r4: RESOURCE_NAME_CLINICALIMPRESSION

string "ClinicalImpression"

health.fhir.r4: RESOURCE_NAME_CODESYSTEM

string "CodeSystem"

health.fhir.r4: RESOURCE_NAME_COMMUNICATION

string "Communication"

health.fhir.r4: RESOURCE_NAME_COMMUNICATIONREQUEST

string "CommunicationRequest"

health.fhir.r4: RESOURCE_NAME_COMPARTMENTDEFINITION

string "CompartmentDefinition"

health.fhir.r4: RESOURCE_NAME_COMPOSITION

string "Composition"

health.fhir.r4: RESOURCE_NAME_CONCEPTMAP

string "ConceptMap"

health.fhir.r4: RESOURCE_NAME_CONDITION

string "Condition"

health.fhir.r4: RESOURCE_NAME_CONSENT

string "Consent"

health.fhir.r4: RESOURCE_NAME_CONTRACT

string "Contract"

health.fhir.r4: RESOURCE_NAME_COVERAGE

string "Coverage"

health.fhir.r4: RESOURCE_NAME_COVERAGEELIGIBILITYREQUEST

string "CoverageEligibilityRequest"

health.fhir.r4: RESOURCE_NAME_COVERAGEELIGIBILITYRESPONSE

string "CoverageEligibilityResponse"

health.fhir.r4: RESOURCE_NAME_DETECTEDISSUE

string "DetectedIssue"

health.fhir.r4: RESOURCE_NAME_DEVICE

string "Device"

health.fhir.r4: RESOURCE_NAME_DEVICEDEFINITION

string "DeviceDefinition"

health.fhir.r4: RESOURCE_NAME_DEVICEMETRIC

string "DeviceMetric"

health.fhir.r4: RESOURCE_NAME_DEVICEREQUEST

string "DeviceRequest"

health.fhir.r4: RESOURCE_NAME_DEVICEUSESTATEMENT

string "DeviceUseStatement"

health.fhir.r4: RESOURCE_NAME_DIAGNOSTICREPORT

string "DiagnosticReport"

health.fhir.r4: RESOURCE_NAME_DOCUMENTMANIFEST

string "DocumentManifest"

health.fhir.r4: RESOURCE_NAME_DOCUMENTREFERENCE

string "DocumentReference"

health.fhir.r4: RESOURCE_NAME_EFFECTEVIDENCESYNTHESIS

string "EffectEvidenceSynthesis"

health.fhir.r4: RESOURCE_NAME_ENCOUNTER

string "Encounter"

health.fhir.r4: RESOURCE_NAME_ENDPOINT

string "Endpoint"

health.fhir.r4: RESOURCE_NAME_ENROLLMENTREQUEST

string "EnrollmentRequest"

health.fhir.r4: RESOURCE_NAME_ENROLLMENTRESPONSE

string "EnrollmentResponse"

health.fhir.r4: RESOURCE_NAME_EPISODEOFCARE

string "EpisodeOfCare"

health.fhir.r4: RESOURCE_NAME_EVENTDEFINITION

string "EventDefinition"

health.fhir.r4: RESOURCE_NAME_EVIDENCE

string "Evidence"

health.fhir.r4: RESOURCE_NAME_EVIDENCEVARIABLE

string "EvidenceVariable"

health.fhir.r4: RESOURCE_NAME_EXAMPLESCENARIO

string "ExampleScenario"

health.fhir.r4: RESOURCE_NAME_EXPLANATIONOFBENEFIT

string "ExplanationOfBenefit"

health.fhir.r4: RESOURCE_NAME_FAMILYMEMBERHISTORY

string "FamilyMemberHistory"

health.fhir.r4: RESOURCE_NAME_FLAG

string "Flag"

health.fhir.r4: RESOURCE_NAME_GOAL

string "Goal"

health.fhir.r4: RESOURCE_NAME_GRAPHDEFINITION

string "GraphDefinition"

health.fhir.r4: RESOURCE_NAME_GROUP

string "Group"

health.fhir.r4: RESOURCE_NAME_GUIDANCERESPONSE

string "GuidanceResponse"

health.fhir.r4: RESOURCE_NAME_HEALTHCARESERVICE

string "HealthcareService"

health.fhir.r4: RESOURCE_NAME_IMAGINGSTUDY

string "ImagingStudy"

health.fhir.r4: RESOURCE_NAME_IMMUNIZATION

string "Immunization"

health.fhir.r4: RESOURCE_NAME_IMMUNIZATIONEVALUATION

string "ImmunizationEvaluation"

health.fhir.r4: RESOURCE_NAME_IMMUNIZATIONRECOMMENDATION

string "ImmunizationRecommendation"

health.fhir.r4: RESOURCE_NAME_IMPLEMENTATIONGUIDE

string "ImplementationGuide"

health.fhir.r4: RESOURCE_NAME_INSURANCEPLAN

string "InsurancePlan"

health.fhir.r4: RESOURCE_NAME_INVOICE

string "Invoice"

health.fhir.r4: RESOURCE_NAME_LIBRARY

string "Library"

health.fhir.r4: RESOURCE_NAME_LINKAGE

string "Linkage"

health.fhir.r4: RESOURCE_NAME_LIST

string "List"

health.fhir.r4: RESOURCE_NAME_LOCATION

string "Location"

health.fhir.r4: RESOURCE_NAME_MEASURE

string "Measure"

health.fhir.r4: RESOURCE_NAME_MEASUREREPORT

string "MeasureReport"

health.fhir.r4: RESOURCE_NAME_MEDIA

string "Media"

health.fhir.r4: RESOURCE_NAME_MEDICATION

string "Medication"

health.fhir.r4: RESOURCE_NAME_MEDICATIONADMINISTRATION

string "MedicationAdministration"

health.fhir.r4: RESOURCE_NAME_MEDICATIONDISPENSE

string "MedicationDispense"

health.fhir.r4: RESOURCE_NAME_MEDICATIONKNOWLEDGE

string "MedicationKnowledge"

health.fhir.r4: RESOURCE_NAME_MEDICATIONREQUEST

string "MedicationRequest"

health.fhir.r4: RESOURCE_NAME_MEDICATIONSTATEMENT

string "MedicationStatement"

health.fhir.r4: RESOURCE_NAME_MEDICINALPRODUCT

string "MedicinalProduct"

health.fhir.r4: RESOURCE_NAME_MEDICINALPRODUCTAUTHORIZATION

string "MedicinalProductAuthorization"

health.fhir.r4: RESOURCE_NAME_MEDICINALPRODUCTCONTRAINDICATION

string "MedicinalProductContraindication"

health.fhir.r4: RESOURCE_NAME_MEDICINALPRODUCTINDICATION

string "MedicinalProductIndication"

health.fhir.r4: RESOURCE_NAME_MEDICINALPRODUCTINGREDIENT

string "MedicinalProductIngredient"

health.fhir.r4: RESOURCE_NAME_MEDICINALPRODUCTINTERACTION

string "MedicinalProductInteraction"

health.fhir.r4: RESOURCE_NAME_MEDICINALPRODUCTMANUFACTURED

string "MedicinalProductManufactured"

health.fhir.r4: RESOURCE_NAME_MEDICINALPRODUCTPACKAGED

string "MedicinalProductPackaged"

health.fhir.r4: RESOURCE_NAME_MEDICINALPRODUCTPHARMACEUTICAL

string "MedicinalProductPharmaceutical"

health.fhir.r4: RESOURCE_NAME_MEDICINALPRODUCTUNDESIRABLEEFFECT

string "MedicinalProductUndesirableEffect"

health.fhir.r4: RESOURCE_NAME_MESSAGEDEFINITION

string "MessageDefinition"

health.fhir.r4: RESOURCE_NAME_MESSAGEHEADER

string "MessageHeader"

health.fhir.r4: RESOURCE_NAME_MOLECULARSEQUENCE

string "MolecularSequence"

health.fhir.r4: RESOURCE_NAME_NAMINGSYSTEM

string "NamingSystem"

health.fhir.r4: RESOURCE_NAME_NUTRITIONORDER

string "NutritionOrder"

health.fhir.r4: RESOURCE_NAME_OBSERVATION

string "Observation"

health.fhir.r4: RESOURCE_NAME_OBSERVATION_VITALSIGNS

string "Observation"

health.fhir.r4: RESOURCE_NAME_OBSERVATIONDEFINITION

string "ObservationDefinition"

health.fhir.r4: RESOURCE_NAME_OPERATIONDEFINITION

string "OperationDefinition"

health.fhir.r4: RESOURCE_NAME_OPERATIONOUTCOME

string "OperationOutcome"

health.fhir.r4: RESOURCE_NAME_ORGANIZATION

string "Organization"

health.fhir.r4: RESOURCE_NAME_ORGANIZATIONAFFILIATION

string "OrganizationAffiliation"

health.fhir.r4: RESOURCE_NAME_PARAMETERS

string "Parameters"

health.fhir.r4: RESOURCE_NAME_PATIENT

string "Patient"

health.fhir.r4: RESOURCE_NAME_PAYMENTNOTICE

string "PaymentNotice"

health.fhir.r4: RESOURCE_NAME_PAYMENTRECONCILIATION

string "PaymentReconciliation"

health.fhir.r4: RESOURCE_NAME_PERSON

string "Person"

health.fhir.r4: RESOURCE_NAME_PLANDEFINITION

string "PlanDefinition"

health.fhir.r4: RESOURCE_NAME_PRACTITIONER

string "Practitioner"

health.fhir.r4: RESOURCE_NAME_PRACTITIONERROLE

string "PractitionerRole"

health.fhir.r4: RESOURCE_NAME_PROCEDURE

string "Procedure"

health.fhir.r4: RESOURCE_NAME_PROVENANCE

string "Provenance"

health.fhir.r4: RESOURCE_NAME_QUESTIONNAIRE

string "Questionnaire"

health.fhir.r4: RESOURCE_NAME_QUESTIONNAIRERESPONSE

string "QuestionnaireResponse"

health.fhir.r4: RESOURCE_NAME_RELATEDPERSON

string "RelatedPerson"

health.fhir.r4: RESOURCE_NAME_REQUESTGROUP

string "RequestGroup"

health.fhir.r4: RESOURCE_NAME_RESEARCHDEFINITION

string "ResearchDefinition"

health.fhir.r4: RESOURCE_NAME_RESEARCHELEMENTDEFINITION

string "ResearchElementDefinition"

health.fhir.r4: RESOURCE_NAME_RESEARCHSTUDY

string "ResearchStudy"

health.fhir.r4: RESOURCE_NAME_RESEARCHSUBJECT

string "ResearchSubject"

health.fhir.r4: RESOURCE_NAME_RISKASSESSMENT

string "RiskAssessment"

health.fhir.r4: RESOURCE_NAME_RISKEVIDENCESYNTHESIS

string "RiskEvidenceSynthesis"

health.fhir.r4: RESOURCE_NAME_SCHEDULE

string "Schedule"

health.fhir.r4: RESOURCE_NAME_SEARCHPARAMETER

string "SearchParameter"

health.fhir.r4: RESOURCE_NAME_SERVICEREQUEST

string "ServiceRequest"

health.fhir.r4: RESOURCE_NAME_SLOT

string "Slot"

health.fhir.r4: RESOURCE_NAME_SPECIMEN

string "Specimen"

health.fhir.r4: RESOURCE_NAME_SPECIMENDEFINITION

string "SpecimenDefinition"

health.fhir.r4: RESOURCE_NAME_STRUCTUREDEFINITION

string "StructureDefinition"

health.fhir.r4: RESOURCE_NAME_STRUCTUREMAP

string "StructureMap"

health.fhir.r4: RESOURCE_NAME_SUBSCRIPTION

string "Subscription"

health.fhir.r4: RESOURCE_NAME_SUBSTANCE

string "Substance"

health.fhir.r4: RESOURCE_NAME_SUBSTANCENUCLEICACID

string "SubstanceNucleicAcid"

health.fhir.r4: RESOURCE_NAME_SUBSTANCEPOLYMER

string "SubstancePolymer"

health.fhir.r4: RESOURCE_NAME_SUBSTANCEPROTEIN

string "SubstanceProtein"

health.fhir.r4: RESOURCE_NAME_SUBSTANCEREFERENCEINFORMATION

string "SubstanceReferenceInformation"

health.fhir.r4: RESOURCE_NAME_SUBSTANCESOURCEMATERIAL

string "SubstanceSourceMaterial"

health.fhir.r4: RESOURCE_NAME_SUBSTANCESPECIFICATION

string "SubstanceSpecification"

health.fhir.r4: RESOURCE_NAME_SUPPLYDELIVERY

string "SupplyDelivery"

health.fhir.r4: RESOURCE_NAME_SUPPLYREQUEST

string "SupplyRequest"

health.fhir.r4: RESOURCE_NAME_TASK

string "Task"

health.fhir.r4: RESOURCE_NAME_TERMINOLOGYCAPABILITIES

string "TerminologyCapabilities"

health.fhir.r4: RESOURCE_NAME_TESTREPORT

string "TestReport"

health.fhir.r4: RESOURCE_NAME_TESTSCRIPT

string "TestScript"

health.fhir.r4: RESOURCE_NAME_VALUESET

string "ValueSet"

health.fhir.r4: RESOURCE_NAME_VERIFICATIONRESULT

string "VerificationResult"

health.fhir.r4: RESOURCE_NAME_VISIONPRESCRIPTION

string "VisionPrescription"

Enums

health.fhir.r4: AccountStatus

AccountStatus enum

Members

CODE_STATUS_INACTIVE

CODE_STATUS_ACTIVE

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r4: ActivityDefinitionIntent

ActivityDefinitionIntent enum

Members

CODE_INTENT_PROPOSAL

CODE_INTENT_INSTANCE_ORDER

CODE_INTENT_FILLER_ORDER

CODE_INTENT_ORIGINAL_ORDER

CODE_INTENT_REFLEX_ORDER

CODE_INTENT_PLAN

CODE_INTENT_DIRECTIVE

CODE_INTENT_ORDER

CODE_INTENT_OPTION

health.fhir.r4: ActivityDefinitionParticipantType

ActivityDefinitionParticipantType enum

Members

CODE_TYPE_RELATED_PERSON

CODE_TYPE_PRACTITIONER

CODE_TYPE_PATIENT

CODE_TYPE_DEVICE

health.fhir.r4: ActivityDefinitionPriority

ActivityDefinitionPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r4: ActivityDefinitionStatus

ActivityDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: AddressType

Members

postal

physical

both

health.fhir.r4: AddressUse

Members

home

work

temp

old

billing

health.fhir.r4: AdverseEventActuality

AdverseEventActuality enum

Members

CODE_ACTUALITY_ACTUAL

CODE_ACTUALITY_POTENTIAL

health.fhir.r4: AllergyIntoleranceCategory

AllergyIntoleranceCategory enum

Members

CODE_CATEGORY_ENVIRONMENT

CODE_CATEGORY_BIOLOGIC

CODE_CATEGORY_MEDICATION

CODE_CATEGORY_FOOD

health.fhir.r4: AllergyIntoleranceCriticality

AllergyIntoleranceCriticality enum

Members

CODE_CRITICALITY_HIGH

CODE_CRITICALITY_LOW

CODE_CRITICALITY_UNABLE_TO_ASSESS

health.fhir.r4: AllergyIntoleranceReactionSeverity

AllergyIntoleranceReactionSeverity enum

Members

CODE_SEVERITY_MILD

CODE_SEVERITY_SEVERE

CODE_SEVERITY_MODERATE

health.fhir.r4: AllergyIntoleranceType

AllergyIntoleranceType enum

Members

CODE_TYPE_INTOLERANCE

CODE_TYPE_ALLERGY

health.fhir.r4: AppointmentParticipantRequired

AppointmentParticipantRequired enum

Members

CODE_REQUIRED_INFORMATION_ONLY

CODE_REQUIRED_OPTIONAL

CODE_REQUIRED_REQUIRED

health.fhir.r4: AppointmentParticipantStatus

AppointmentParticipantStatus enum

Members

CODE_STATUS_DECLINED

CODE_STATUS_NEEDS_ACTION

CODE_STATUS_ACCEPTED

CODE_STATUS_TENTATIVE

health.fhir.r4: AppointmentResponseParticipantStatus

AppointmentResponseParticipantStatus enum

Members

CODE_PARTICIPANTSTATUS_DECLINED

CODE_PARTICIPANTSTATUS_NEEDS_ACTION

CODE_PARTICIPANTSTATUS_ACCEPTED

CODE_PARTICIPANTSTATUS_TENTATIVE

health.fhir.r4: AppointmentStatus

AppointmentStatus enum

Members

CODE_STATUS_ARRIVED

CODE_STATUS_BOOKED

CODE_STATUS_PROPOSED

CODE_STATUS_PENDING

CODE_STATUS_FULFILLED

CODE_STATUS_CANCELLED

CODE_STATUS_NOSHOW

CODE_STATUS_WAITLIST

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_CHECKED_IN

health.fhir.r4: BiologicallyDerivedProductProductCategory

BiologicallyDerivedProductProductCategory enum

Members

CODE_PRODUCTCATEGORY_ORGAN

CODE_PRODUCTCATEGORY_CELLS

CODE_PRODUCTCATEGORY_BIOLOGICALAGENT

CODE_PRODUCTCATEGORY_TISSUE

CODE_PRODUCTCATEGORY_FLUID

health.fhir.r4: BiologicallyDerivedProductStatus

BiologicallyDerivedProductStatus enum

Members

CODE_STATUS_UNAVAILABLE

CODE_STATUS_AVAILABLE

health.fhir.r4: BiologicallyDerivedProductStorageScale

BiologicallyDerivedProductStorageScale enum

Members

CODE_SCALE_KELVIN

CODE_SCALE_CELSIUS

CODE_SCALE_FARENHEIT

health.fhir.r4: BundleType

Members

BUNDLE_TYPE_DOCUMENT

BUNDLE_TYPE_MESSAGE

BUNDLE_TYPE_TRANSACTION

BUNDLE_TYPE_TRANSACTION_RESPONSE

BUNDLE_TYPE_BATCH

BUNDLE_TYPE_BATCH_RESPONSE

BUNDLE_TYPE_HISTORY

BUNDLE_TYPE_SEARCHSET

BUNDLE_TYPE_COLLECTION

health.fhir.r4: CapabilityStatementDocumentMode

CapabilityStatementDocumentMode enum

Members

CODE_MODE_PRODUCER

CODE_MODE_CONSUMER

health.fhir.r4: CapabilityStatementFormat

CapabilityStatementFormat enum

Members

CODE_FORMAT_FORMATS

CODE_FORMAT_MIME

CODE_FORMAT_JSON

CODE_FORMAT_TTL

health.fhir.r4: CapabilityStatementKind

CapabilityStatementKind enum

Members

CODE_KIND_CAPABILITY

CODE_KIND_REQUIREMENTS

CODE_KIND_INSTANCE

health.fhir.r4: CapabilityStatementMessagingSupportedMessageMode

CapabilityStatementMessagingSupportedMessageMode enum

Members

CODE_MODE_RECEIVER

CODE_MODE_SENDER

health.fhir.r4: CapabilityStatementRestInteractionCode

CapabilityStatementRestInteractionCode enum

Members

CODE_CODE_SEARCH_SYSTEM

CODE_CODE_HISTORY_SYSTEM

CODE_CODE_BATCH

CODE_CODE_TRANSACTION

health.fhir.r4: CapabilityStatementRestMode

CapabilityStatementRestMode enum

Members

CODE_MODE_SERVER

CODE_MODE_CLIENT

health.fhir.r4: CapabilityStatementRestResourceConditionalDelete

CapabilityStatementRestResourceConditionalDelete enum

Members

CODE_CONDITIONALDELETE_SINGLE

CODE_CONDITIONALDELETE_MULTIPLE

CODE_CONDITIONALDELETE_NOT_SUPPORTED

health.fhir.r4: CapabilityStatementRestResourceConditionalRead

CapabilityStatementRestResourceConditionalRead enum

Members

CODE_CONDITIONALREAD_NOT_SUPPORTED

CODE_CONDITIONALREAD_MODIFIED_SINCE

CODE_CONDITIONALREAD_FULL_SUPPORT

CODE_CONDITIONALREAD_NOT_MATCH

health.fhir.r4: CapabilityStatementRestResourceInteractionCode

CapabilityStatementRestResourceInteractionCode enum

Members

CODE_CODE_PATCH

CODE_CODE_READ

CODE_CODE_SEARCH_TYPE

CODE_CODE_VREAD

CODE_CODE_UPDATE

CODE_CODE_CREATE

CODE_CODE_HISTORY_INSTANCE

CODE_CODE_DELETE

CODE_CODE_HISTORY_TYPE

health.fhir.r4: CapabilityStatementRestResourceReferencePolicy

CapabilityStatementRestResourceReferencePolicy enum

Members

CODE_REFERENCEPOLICY_RESOLVES

CODE_REFERENCEPOLICY_ENFORCED

CODE_REFERENCEPOLICY_LOGICAL

CODE_REFERENCEPOLICY_LOCAL

CODE_REFERENCEPOLICY_LITERAL

health.fhir.r4: CapabilityStatementRestResourceSearchParamType

CapabilityStatementRestResourceSearchParamType enum

Members

CODE_TYPE_DATE

CODE_TYPE_REFERENCE

CODE_TYPE_SPECIAL

CODE_TYPE_NUMBER

CODE_TYPE_QUANTITY

CODE_TYPE_STRING

CODE_TYPE_COMPOSITE

CODE_TYPE_URI

CODE_TYPE_TOKEN

health.fhir.r4: CapabilityStatementRestResourceVersioning

CapabilityStatementRestResourceVersioning enum

Members

CODE_VERSIONING_VERSIONED_UPDATE

CODE_VERSIONING_VERSIONED

CODE_VERSIONING_NO_VERSION

health.fhir.r4: CapabilityStatementStatus

CapabilityStatementStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: CarePlanActivityDetailKind

CarePlanActivityDetailKind enum

Members

CODE_KIND_APPOINTMENT

CODE_KIND_MEDICATIONREQUEST

CODE_KIND_TASK

CODE_KIND_NUTRITIONORDER

CODE_KIND_VISIONPRESCRIPTION

CODE_KIND_DEVICEREQUEST

CODE_KIND_SERVICEREQUEST

CODE_KIND_COMMUNICATIONREQUEST

health.fhir.r4: CarePlanActivityDetailStatus

CarePlanActivityDetailStatus enum

Members

CODE_STATUS_STOPPED

CODE_STATUS_SCHEDULED

CODE_STATUS_NOT_STARTED

CODE_STATUS_CANCELLED

CODE_STATUS_COMPLETED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r4: CarePlanIntent

CarePlanIntent enum

Members

CODE_INTENT_PROPOSAL

CODE_INTENT_PLAN

CODE_INTENT_ORDER

CODE_INTENT_OPTION

health.fhir.r4: CarePlanStatus

CarePlanStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_COMPLETED

CODE_STATUS_REVOKED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r4: CareTeamStatus

CareTeamStatus enum

Members

CODE_STATUS_INACTIVE

CODE_STATUS_PROPOSED

CODE_STATUS_ACTIVE

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_SUSPENDED

health.fhir.r4: CatalogEntryRelatedEntryRelationtype

CatalogEntryRelatedEntryRelationtype enum

Members

CODE_RELATIONTYPE_IS_REPLACED_BY

CODE_RELATIONTYPE_TRIGGERS

health.fhir.r4: CatalogEntryStatus

CatalogEntryStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: ChargeItemDefinitionPropertyGroupPriceComponentType

ChargeItemDefinitionPropertyGroupPriceComponentType enum

Members

CODE_TYPE_SURCHARGE

CODE_TYPE_DEDUCTION

CODE_TYPE_DISCOUNT

CODE_TYPE_TAX

CODE_TYPE_INFORMATIONAL

CODE_TYPE_BASE

health.fhir.r4: ChargeItemDefinitionStatus

ChargeItemDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: ChargeItemStatus

ChargeItemStatus enum

Members

CODE_STATUS_NOT_BILLABLE

CODE_STATUS_BILLED

CODE_STATUS_ABORTED

CODE_STATUS_PLANNED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_BILLABLE

CODE_STATUS_UNKNOWN

health.fhir.r4: ClaimResponseOutcome

ClaimResponseOutcome enum

Members

CODE_OUTCOME_QUEUED

CODE_OUTCOME_COMPLETE

CODE_OUTCOME_ERROR

CODE_OUTCOME_PARTIAL

health.fhir.r4: ClaimResponseProcessNoteType

ClaimResponseProcessNoteType enum

Members

CODE_TYPE_PRINT

CODE_TYPE_DISPLAY

CODE_TYPE_PRINTOPER

health.fhir.r4: ClaimResponseStatus

ClaimResponseStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4: ClaimResponseUse

ClaimResponseUse enum

Members

CODE_USE_PREDETERMINATION

CODE_USE_PREAUTHORIZATION

CODE_USE_CLAIM

health.fhir.r4: ClaimStatus

ClaimStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4: ClaimUse

ClaimUse enum

Members

CODE_USE_PREDETERMINATION

CODE_USE_PREAUTHORIZATION

CODE_USE_CLAIM

health.fhir.r4: ClinicalImpressionStatus

ClinicalImpressionStatus enum

Members

CODE_STATUS_COMPLETED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

health.fhir.r4: CodeSystemContent

CodeSystemContent enum

Members

CODE_CONTENT_FRAGMENT

CODE_CONTENT_SUPPLEMENT

CODE_CONTENT_NOT_PRESENT

CODE_CONTENT_COMPLETE

CODE_CONTENT_EXAMPLE

health.fhir.r4: CodeSystemFilterOperator

CodeSystemFilterOperator enum

Members

CODE_OPERATOR_IS_NOT_A

CODE_OPERATOR_REGEX

CODE_OPERATOR_IN

CODE_OPERATOR_DESCENDENT_OF

CODE_OPERATOR_NOT_IN

CODE_OPERATOR_EXISTS

CODE_OPERATOR_GENERALIZES

CODE_OPERATOR_EQUAL

CODE_OPERATOR_IS_A

health.fhir.r4: CodeSystemHierarchyMeaning

CodeSystemHierarchyMeaning enum

Members

CODE_HIERARCHYMEANING_CLASSIFIED_WITH

CODE_HIERARCHYMEANING_PART_OF

CODE_HIERARCHYMEANING_GROUPED_BY

CODE_HIERARCHYMEANING_IS_A

health.fhir.r4: CodeSystemPropertyType

CodeSystemPropertyType enum

Members

CODE_TYPE_DATETIME

CODE_TYPE_CODE

CODE_TYPE_BOOLEAN

CODE_TYPE_STRING

CODE_TYPE_CODING

CODE_TYPE_INTEGER

CODE_TYPE_DECIMAL

health.fhir.r4: CodeSystemStatus

CodeSystemStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: CommunicationPriority

CommunicationPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r4: CommunicationRequestPriority

CommunicationRequestPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r4: CommunicationRequestStatus

CommunicationRequestStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_COMPLETED

CODE_STATUS_REVOKED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r4: CommunicationStatus

CommunicationStatus enum

Members

CODE_STATUS_STOPPED

CODE_STATUS_COMPLETED

CODE_STATUS_NOT_DONE

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

CODE_STATUS_ON_HOLD

CODE_STATUS_PREPARATION

CODE_STATUS_UNKNOWN

health.fhir.r4: CompartmentDefinitionCode

CompartmentDefinitionCode enum

Members

CODE_CODE_PRACTITIONER

CODE_CODE_DEVICE

CODE_CODE_PATIENT

CODE_CODE_ENCOUNTER

CODE_CODE_RELATEDPERSON

health.fhir.r4: CompartmentDefinitionStatus

CompartmentDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: CompositionAttesterMode

CompositionAttesterMode enum

Members

CODE_MODE_LEGAL

CODE_MODE_OFFICIAL

CODE_MODE_PERSONAL

CODE_MODE_PROFESSIONAL

health.fhir.r4: CompositionRelatesToCode

CompositionRelatesToCode enum

Members

CODE_CODE_SIGNS

CODE_CODE_REPLACES

CODE_CODE_TRANSFORMS

CODE_CODE_APPENDS

health.fhir.r4: CompositionSectionMode

CompositionSectionMode enum

Members

CODE_MODE_CHANGES

CODE_MODE_WORKING

CODE_MODE_SNAPSHOT

health.fhir.r4: CompositionStatus

CompositionStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_PRELIMINARY

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4: ConceptMapGroupElementTargetEquivalence

ConceptMapGroupElementTargetEquivalence enum

Members

CODE_EQUIVALENCE_EQUAL

CODE_EQUIVALENCE_INEXACT

CODE_EQUIVALENCE_EQUIVALENT

CODE_EQUIVALENCE_WIDER

CODE_EQUIVALENCE_SPECIALIZES

CODE_EQUIVALENCE_DISJOINT

CODE_EQUIVALENCE_NARROWER

CODE_EQUIVALENCE_UNMATCHED

CODE_EQUIVALENCE_RELATEDTO

CODE_EQUIVALENCE_SUBSUMES

health.fhir.r4: ConceptMapGroupUnmappedMode

ConceptMapGroupUnmappedMode enum

Members

CODE_MODE_PROVIDED

CODE_MODE_FIXED

CODE_MODE_OTHER_MAP

health.fhir.r4: ConceptMapStatus

ConceptMapStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: ConsentProvisionDataMeaning

ConsentProvisionDataMeaning enum

Members

CODE_MEANING_INSTANCE

CODE_MEANING_RELATED

CODE_MEANING_DEPENDENTS

CODE_MEANING_AUTHOREDBY

health.fhir.r4: ConsentProvisionType

ConsentProvisionType enum

Members

CODE_TYPE_DENY

CODE_TYPE_PERMIT

health.fhir.r4: ConsentStatus

ConsentStatus enum

Members

CODE_STATUS_INACTIVE

CODE_STATUS_PROPOSED

CODE_STATUS_REJECTED

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4: ContactPointSystem

Members

phone

fax

pager

url

sms

other

health.fhir.r4: ContactPointUse

Members

home

work

temp

old

mobile

health.fhir.r4: ContractContentDefinitionPublicationStatus

ContractContentDefinitionPublicationStatus enum

Members

CODE_PUBLICATIONSTATUS_DISPUTED

CODE_PUBLICATIONSTATUS_REJECTED

CODE_PUBLICATIONSTATUS_EXECUTED

CODE_PUBLICATIONSTATUS_NEGOTIABLE

CODE_PUBLICATIONSTATUS_REVOKED

CODE_PUBLICATIONSTATUS_EXECUTABLE

CODE_PUBLICATIONSTATUS_AMENDED

CODE_PUBLICATIONSTATUS_RENEWED

CODE_PUBLICATIONSTATUS_APPENDED

CODE_PUBLICATIONSTATUS_OFFERED

CODE_PUBLICATIONSTATUS_CANCELLED

CODE_PUBLICATIONSTATUS_ENTERED_IN_ERROR

CODE_PUBLICATIONSTATUS_TERMINATED

CODE_PUBLICATIONSTATUS_POLICY

CODE_PUBLICATIONSTATUS_RESOLVED

health.fhir.r4: ContractStatus

ContractStatus enum

Members

CODE_STATUS_DISPUTED

CODE_STATUS_REJECTED

CODE_STATUS_EXECUTED

CODE_STATUS_NEGOTIABLE

CODE_STATUS_REVOKED

CODE_STATUS_EXECUTABLE

CODE_STATUS_AMENDED

CODE_STATUS_RENEWED

CODE_STATUS_APPENDED

CODE_STATUS_OFFERED

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_TERMINATED

CODE_STATUS_POLICY

CODE_STATUS_RESOLVED

health.fhir.r4: ContributerType

Members

author

editor

reviewer

endorser

health.fhir.r4: ContributorType

Members

author

editor

reviewer

endorser

health.fhir.r4: CoverageEligibilityRequestPurpose

CoverageEligibilityRequestPurpose enum

Members

CODE_PURPOSE_BENEFITS

CODE_PURPOSE_DISCOVERY

CODE_PURPOSE_AUTH_REQUIREMENTS

CODE_PURPOSE_VALIDATION

health.fhir.r4: CoverageEligibilityRequestStatus

CoverageEligibilityRequestStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4: CoverageEligibilityResponseOutcome

CoverageEligibilityResponseOutcome enum

Members

CODE_OUTCOME_QUEUED

CODE_OUTCOME_COMPLETE

CODE_OUTCOME_ERROR

CODE_OUTCOME_PARTIAL

health.fhir.r4: CoverageEligibilityResponsePurpose

CoverageEligibilityResponsePurpose enum

Members

CODE_PURPOSE_BENEFITS

CODE_PURPOSE_DISCOVERY

CODE_PURPOSE_AUTH_REQUIREMENTS

CODE_PURPOSE_VALIDATION

health.fhir.r4: CoverageEligibilityResponseStatus

CoverageEligibilityResponseStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4: CoverageStatus

CoverageStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4: Daycode

Members

mon

tue

wed

thu

fri

sat

sun

health.fhir.r4: DetectedIssueSeverity

DetectedIssueSeverity enum

Members

CODE_SEVERITY_HIGH

CODE_SEVERITY_LOW

CODE_SEVERITY_MODERATE

health.fhir.r4: DetectedIssueStatus

DetectedIssueStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r4: DeviceDefinitionDeviceNameType

DeviceDefinitionDeviceNameType enum

Members

CODE_TYPE_UDI_LABEL_NAME

CODE_TYPE_OTHER

CODE_TYPE_MANUFACTURER_NAME

CODE_TYPE_MODEL_NAME

CODE_TYPE_USER_FRIENDLY_NAME

CODE_TYPE_PATIENT_REPORTED_NAME

health.fhir.r4: DeviceDeviceNameType

DeviceDeviceNameType enum

Members

CODE_TYPE_UDI_LABEL_NAME

CODE_TYPE_OTHER

CODE_TYPE_MANUFACTURER_NAME

CODE_TYPE_MODEL_NAME

CODE_TYPE_USER_FRIENDLY_NAME

CODE_TYPE_PATIENT_REPORTED_NAME

health.fhir.r4: DeviceMetricCalibrationState

DeviceMetricCalibrationState enum

Members

CODE_STATE_UNSPECIFIED

CODE_STATE_NOT_CALIBRATED

CODE_STATE_CALIBRATION_REQUIRED

CODE_STATE_CALIBRATED

health.fhir.r4: DeviceMetricCalibrationType

DeviceMetricCalibrationType enum

Members

CODE_TYPE_OFFSET

CODE_TYPE_UNSPECIFIED

CODE_TYPE_TWO_POINT

CODE_TYPE_GAIN

health.fhir.r4: DeviceMetricCategory

DeviceMetricCategory enum

Members

CODE_CATEGORY_CALCULATION

CODE_CATEGORY_UNSPECIFIED

CODE_CATEGORY_MEASUREMENT

CODE_CATEGORY_SETTING

health.fhir.r4: DeviceMetricColor

DeviceMetricColor enum

Members

CODE_COLOR_RED

CODE_COLOR_MAGENTA

CODE_COLOR_GREEN

CODE_COLOR_BLUE

CODE_COLOR_WHITE

CODE_COLOR_BLACK

CODE_COLOR_YELLOW

CODE_COLOR_CYAN

health.fhir.r4: DeviceMetricOperationalStatus

DeviceMetricOperationalStatus enum

Members

CODE_OPERATIONALSTATUS_STANDBY

CODE_OPERATIONALSTATUS_ENTERED_IN_ERROR

CODE_OPERATIONALSTATUS_OFF

CODE_OPERATIONALSTATUS_ON

health.fhir.r4: DeviceRequestIntent

DeviceRequestIntent enum

Members

CODE_INTENT_PROPOSAL

CODE_INTENT_INSTANCE_ORDER

CODE_INTENT_FILLER_ORDER

CODE_INTENT_ORIGINAL_ORDER

CODE_INTENT_REFLEX_ORDER

CODE_INTENT_PLAN

CODE_INTENT_DIRECTIVE

CODE_INTENT_ORDER

CODE_INTENT_OPTION

health.fhir.r4: DeviceRequestPriority

DeviceRequestPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r4: DeviceRequestStatus

DeviceRequestStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_COMPLETED

CODE_STATUS_REVOKED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r4: DeviceStatus

DeviceStatus enum

Members

CODE_STATUS_INACTIVE

CODE_STATUS_ACTIVE

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_UNKNOWN

health.fhir.r4: DeviceUdiCarrierEntryType

DeviceUdiCarrierEntryType enum

Members

CODE_ENTRYTYPE_RFID

CODE_ENTRYTYPE_MANUAL

CODE_ENTRYTYPE_BARCODE

health.fhir.r4: DeviceUseStatementStatus

DeviceUseStatementStatus enum

Members

CODE_STATUS_ACTIVE

CODE_STATUS_COMPLETED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4: DiagnosticReportStatus

DiagnosticReportStatus enum

Members

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

CODE_STATUS_PARTIAL

health.fhir.r4: DirectionCode

Members

'ascending

'descending

health.fhir.r4: DocumentManifestStatus

DocumentManifestStatus enum

Members

CODE_STATUS_CURRENT

CODE_STATUS_SUPERSEDED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4: DocumentReferenceDocStatus

DocumentReferenceDocStatus enum

Members

CODE_DOCSTATUS_AMENDED

CODE_DOCSTATUS_FINAL

CODE_DOCSTATUS_PRELIMINARY

CODE_DOCSTATUS_ENTERED_IN_ERROR

health.fhir.r4: DocumentReferenceRelatesToCode

DocumentReferenceRelatesToCode enum

Members

CODE_CODE_SIGNS

CODE_CODE_REPLACES

CODE_CODE_TRANSFORMS

CODE_CODE_APPENDS

health.fhir.r4: DocumentReferenceStatus

DocumentReferenceStatus enum

Members

CODE_STATUS_CURRENT

CODE_STATUS_SUPERSEDED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4: EffectEvidenceSynthesisResultsByExposureExposureState

EffectEvidenceSynthesisResultsByExposureExposureState enum

Members

CODE_EXPOSURESTATE_EXPOSURE_ALTERNATIVE

CODE_EXPOSURESTATE_EXPOSURE

health.fhir.r4: EffectEvidenceSynthesisStatus

EffectEvidenceSynthesisStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: ElementDiscriminatorType

Members

value

exists

pattern

'type

profile

health.fhir.r4: ElementSlicingRules

Members

closed

open

openAtEnd

health.fhir.r4: EncounterLocationStatus

EncounterLocationStatus enum

Members

CODE_STATUS_RESERVED

CODE_STATUS_ACTIVE

CODE_STATUS_PLANNED

CODE_STATUS_COMPLETED

health.fhir.r4: EncounterStatus

EncounterStatus enum

Members

CODE_STATUS_TRIAGED

CODE_STATUS_ARRIVED

CODE_STATUS_ONLEAVE

CODE_STATUS_CANCELLED

CODE_STATUS_FINISHED

CODE_STATUS_PLANNED

CODE_STATUS_IN_PROGRESS

health.fhir.r4: EncounterStatusHistoryStatus

EncounterStatusHistoryStatus enum

Members

CODE_STATUS_TRIAGED

CODE_STATUS_ARRIVED

CODE_STATUS_ONLEAVE

CODE_STATUS_CANCELLED

CODE_STATUS_FINISHED

CODE_STATUS_PLANNED

CODE_STATUS_IN_PROGRESS

health.fhir.r4: EndpointStatus

EndpointStatus enum

Members

CODE_STATUS_TEST

CODE_STATUS_ACTIVE

CODE_STATUS_ERROR

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_SUSPENDED

CODE_STATUS_OFF

health.fhir.r4: EnrollmentRequestStatus

EnrollmentRequestStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4: EnrollmentResponseOutcome

EnrollmentResponseOutcome enum

Members

CODE_OUTCOME_QUEUED

CODE_OUTCOME_COMPLETE

CODE_OUTCOME_ERROR

CODE_OUTCOME_PARTIAL

health.fhir.r4: EnrollmentResponseStatus

EnrollmentResponseStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4: EpisodeOfCareStatus

EpisodeOfCareStatus enum

Members

CODE_STATUS_ONHOLD

CODE_STATUS_WAITLIST

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_FINISHED

CODE_STATUS_PLANNED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4: EpisodeOfCareStatusHistoryStatus

EpisodeOfCareStatusHistoryStatus enum

Members

CODE_STATUS_ONHOLD

CODE_STATUS_WAITLIST

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_FINISHED

CODE_STATUS_PLANNED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4: EventDefinitionStatus

EventDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: EvidenceStatus

EvidenceStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: EvidenceVariableCharacteristicGroupMeasure

EvidenceVariableCharacteristicGroupMeasure enum

Members

CODE_GROUPMEASURE_MEAN_OF_MEDIAN

CODE_GROUPMEASURE_MEDIAN

CODE_GROUPMEASURE_MEAN

CODE_GROUPMEASURE_MEDIAN_OF_MEDIAN

CODE_GROUPMEASURE_MEDIAN_OF_MEAN

CODE_GROUPMEASURE_MEAN_OF_MEAN

health.fhir.r4: EvidenceVariableStatus

EvidenceVariableStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: EvidenceVariableType

EvidenceVariableType enum

Members

CODE_TYPE_CONTINUOUS

CODE_TYPE_DESCRIPTIVE

CODE_TYPE_DICHOTOMOUS

health.fhir.r4: ExampleScenarioActorType

ExampleScenarioActorType enum

Members

CODE_TYPE_PERSON

CODE_TYPE_ENTITY

health.fhir.r4: ExampleScenarioStatus

ExampleScenarioStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: ExplanationOfBenefitOutcome

ExplanationOfBenefitOutcome enum

Members

CODE_OUTCOME_QUEUED

CODE_OUTCOME_COMPLETE

CODE_OUTCOME_ERROR

CODE_OUTCOME_PARTIAL

health.fhir.r4: ExplanationOfBenefitProcessNoteType

ExplanationOfBenefitProcessNoteType enum

Members

CODE_TYPE_PRINT

CODE_TYPE_DISPLAY

CODE_TYPE_PRINTOPER

health.fhir.r4: ExplanationOfBenefitStatus

ExplanationOfBenefitStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4: ExplanationOfBenefitUse

ExplanationOfBenefitUse enum

Members

CODE_USE_PREDETERMINATION

CODE_USE_PREAUTHORIZATION

CODE_USE_CLAIM

health.fhir.r4: FamilyMemberHistoryStatus

FamilyMemberHistoryStatus enum

Members

CODE_STATUS_COMPLETED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_HEALTH_UNKNOWN

CODE_STATUS_PARTIAL

health.fhir.r4: FHIRInteractionLevel

FHIR Interaction levels

Members

FHIR_INTERACTION_INSTANCE

FHIR_INTERACTION_TYPE

FHIR_INTERACTION_SYSTEM

health.fhir.r4: FHIRInteractionType

FHIR REST Interactions

Members

READ

VREAD

UPDATE

PATCH

DELETE

HISTORY

CREATE

CAPABILITIES

BATCH

TRANSACTION

health.fhir.r4: FHIRPayloadFormat

FHIR Payload formats

Members

JSON

XML

health.fhir.r4: FHIRSearchParameterModifier

FHIR search parameter modifiers

Members

MODIFIER_ABOVE

MODIFIER_BELOW

MODIFIER_CODE_TEXT

MODIFIER_CONTAINS

MODIFIER_EXACT

MODIFIER_IDENTIFIER

MODIFIER_IN

MODIFIER_ITERATE

MODIFIER_MISSING

MODIFIER_NOT

MODIFIER_NOT_IN

MODIFIER_OF_TYPE

MODIFIER_TEXT

MODIFIER_TEXT_ADVANCED

health.fhir.r4: FHIRSearchParameterType

FHIR search parameter types

Members

NUMBER

DATE

STRING

TOKEN

REFERENCE

COMPOSITE

QUANTITY

URI

SPECIAL

health.fhir.r4: FlagStatus

FlagStatus enum

Members

CODE_STATUS_INACTIVE

CODE_STATUS_ACTIVE

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4: GoalLifecycleStatus

GoalLifecycleStatus enum

Members

CODE_LIFECYCLESTATUS_PROPOSED

CODE_LIFECYCLESTATUS_REJECTED

CODE_LIFECYCLESTATUS_ACCEPTED

CODE_LIFECYCLESTATUS_ACTIVE

CODE_LIFECYCLESTATUS_CANCELLED

CODE_LIFECYCLESTATUS_PLANNED

CODE_LIFECYCLESTATUS_COMPLETED

CODE_LIFECYCLESTATUS_ENTERED_IN_ERROR

CODE_LIFECYCLESTATUS_ON_HOLD

health.fhir.r4: GraphDefinitionLinkTargetCompartmentCode

GraphDefinitionLinkTargetCompartmentCode enum

Members

CODE_CODE_PRACTITIONER

CODE_CODE_DEVICE

CODE_CODE_PATIENT

CODE_CODE_ENCOUNTER

CODE_CODE_RELATEDPERSON

health.fhir.r4: GraphDefinitionLinkTargetCompartmentRule

GraphDefinitionLinkTargetCompartmentRule enum

Members

CODE_RULE_IDENTICAL

CODE_RULE_CUSTOM

CODE_RULE_DIFFERENT

CODE_RULE_MATCHING

health.fhir.r4: GraphDefinitionLinkTargetCompartmentUse

GraphDefinitionLinkTargetCompartmentUse enum

Members

CODE_USE_CONDITION

CODE_USE_REQUIREMENT

health.fhir.r4: GraphDefinitionStatus

GraphDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: GroupType

GroupType enum

Members

CODE_TYPE_PRACTITIONER

CODE_TYPE_PERSON

CODE_TYPE_SUBSTANCE

CODE_TYPE_ANIMAL

CODE_TYPE_MEDICATION

CODE_TYPE_DEVICE

health.fhir.r4: GuidanceResponseStatus

GuidanceResponseStatus enum

Members

CODE_STATUS_SUCCESS

CODE_STATUS_FAILURE

CODE_STATUS_DATA_REQUIRED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

CODE_STATUS_DATA_REQUESTED

health.fhir.r4: HealthcareServiceAvailableTimeDaysOfWeek

HealthcareServiceAvailableTimeDaysOfWeek enum

Members

CODE_DAYSOFWEEK_THU

CODE_DAYSOFWEEK_TUE

CODE_DAYSOFWEEK_WED

CODE_DAYSOFWEEK_SAT

CODE_DAYSOFWEEK_FRI

CODE_DAYSOFWEEK_MON

CODE_DAYSOFWEEK_SUN

health.fhir.r4: HTTPVerb

Members

GET

HEAD

POST

PUT

DELETE

PATCH

health.fhir.r4: HumanNameUse

Members

usual

official

temp

nickname

anonymous

old

maiden

health.fhir.r4: IdentifierUse

Members

usual

official

temp

secondary

old

health.fhir.r4: ImagingStudyStatus

ImagingStudyStatus enum

Members

CODE_STATUS_AVAILABLE

CODE_STATUS_REGISTERED

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_UNKNOWN

health.fhir.r4: ImmunizationEvaluationStatus

ImmunizationEvaluationStatus enum

Members

CODE_STATUS_COMPLETED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4: ImmunizationStatus

ImmunizationStatus enum

Members

CODE_STATUS_COMPLETED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_NOT_DONE

health.fhir.r4: ImplementationGuideDefinitionPageGeneration

ImplementationGuideDefinitionPageGeneration enum

Members

CODE_GENERATION_GENERATED

CODE_GENERATION_XML

CODE_GENERATION_MARKDOWN

CODE_GENERATION_HTML

health.fhir.r4: ImplementationGuideDefinitionParameterCode

ImplementationGuideDefinitionParameterCode enum

Members

CODE_CODE_GENERATE_JSON

CODE_CODE_EXPANSION_PARAMETER

CODE_CODE_GENERATE_XML

CODE_CODE_GENERATE_TURTLE

CODE_CODE_APPLY

CODE_CODE_RULE_BROKEN_LINKS

CODE_CODE_PATH_RESOURCE

CODE_CODE_HTML_TEMPLATE

CODE_CODE_PATH_PAGES

CODE_CODE_PATH_TX_CACHE

health.fhir.r4: ImplementationGuideStatus

ImplementationGuideStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: InsurancePlanStatus

InsurancePlanStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: InvoiceLineItemPriceComponentType

InvoiceLineItemPriceComponentType enum

Members

CODE_TYPE_SURCHARGE

CODE_TYPE_DEDUCTION

CODE_TYPE_DISCOUNT

CODE_TYPE_TAX

CODE_TYPE_INFORMATIONAL

CODE_TYPE_BASE

health.fhir.r4: InvoiceStatus

InvoiceStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_CANCELLED

CODE_STATUS_ISSUED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_BALANCED

health.fhir.r4: IssueType

Code that describes the type of issue.

Members

INVALID

INVALID_STRUCTURE

INVALID_REQUIRED

INVALID_VALUE

INVALID_INVARIANT

SECURITY

SECURITY_LOGIN

SECURITY_UNKNOWN

SECURITY_EXPIRED

SECURITY_FORBIDDEN

SECURITY_SUPPRESSED

PROCESSING

PROCESSING_NOT_SUPPORTED

PROCESSING_DUPLICATE

PROCESSING_MULTIPLE_MATCHES

PROCESSING_NOT_FOUND

PROCESSING_NOT_FOUND_DELETED

PROCESSING_TOO_LONG

PROCESSING_CODE_INVALID

PROCESSING_EXTENSION

PROCESSING_TOO_COSTLY

PROCESSING_BUSINESS_RULE

PROCESSING_CONFLICT

TRANSIENT

TRANSIENT_LOCK_ERROR

TRANSIENT_NO_STORE

TRANSIENT_EXCEPTION

TRANSIENT_TIMEOUT

TRANSIENT_INCOMPLETE

TRANSIENT_THROTTLED

INFORMATIONAL

health.fhir.r4: LibraryStatus

LibraryStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: LinkageItemType

LinkageItemType enum

Members

CODE_TYPE_ALTERNATE

CODE_TYPE_HISTORICAL

CODE_TYPE_SOURCE

health.fhir.r4: ListMode

ListMode enum

Members

CODE_MODE_CHANGES

CODE_MODE_WORKING

CODE_MODE_SNAPSHOT

health.fhir.r4: ListStatus

ListStatus enum

Members

CODE_STATUS_CURRENT

CODE_STATUS_RETIRED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4: LocationHoursOfOperationDaysOfWeek

LocationHoursOfOperationDaysOfWeek enum

Members

CODE_DAYSOFWEEK_THU

CODE_DAYSOFWEEK_TUE

CODE_DAYSOFWEEK_WED

CODE_DAYSOFWEEK_SAT

CODE_DAYSOFWEEK_FRI

CODE_DAYSOFWEEK_MON

CODE_DAYSOFWEEK_SUN

health.fhir.r4: LocationMode

LocationMode enum

Members

CODE_MODE_INSTANCE

CODE_MODE_KIND

health.fhir.r4: LocationStatus

LocationStatus enum

Members

CODE_STATUS_INACTIVE

CODE_STATUS_ACTIVE

CODE_STATUS_SUSPENDED

health.fhir.r4: MeasureReportStatus

MeasureReportStatus enum

Members

CODE_STATUS_PENDING

CODE_STATUS_COMPLETE

CODE_STATUS_ERROR

health.fhir.r4: MeasureReportType

MeasureReportType enum

Members

CODE_TYPE_SUMMARY

CODE_TYPE_INDIVIDUAL

CODE_TYPE_DATA_COLLECTION

CODE_TYPE_SUBJECT_LIST

health.fhir.r4: MeasureStatus

MeasureStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: MediaStatus

MediaStatus enum

Members

CODE_STATUS_STOPPED

CODE_STATUS_COMPLETED

CODE_STATUS_NOT_DONE

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

CODE_STATUS_ON_HOLD

CODE_STATUS_PREPARATION

CODE_STATUS_UNKNOWN

health.fhir.r4: MedicationAdministrationStatus

MedicationAdministrationStatus enum

Members

CODE_STATUS_STOPPED

CODE_STATUS_COMPLETED

CODE_STATUS_NOT_DONE

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r4: MedicationDispenseStatus

MedicationDispenseStatus enum

Members

CODE_STATUS_STOPPED

CODE_STATUS_DECLINED

CODE_STATUS_CANCELLED

CODE_STATUS_COMPLETED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

CODE_STATUS_ON_HOLD

CODE_STATUS_PREPARATION

CODE_STATUS_UNKNOWN

health.fhir.r4: MedicationKnowledgeStatus

MedicationKnowledgeStatus enum

Members

CODE_STATUS_INACTIVE

CODE_STATUS_ACTIVE

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4: MedicationRequestIntent

MedicationRequestIntent enum

Members

CODE_INTENT_PROPOSAL

CODE_INTENT_INSTANCE_ORDER

CODE_INTENT_FILLER_ORDER

CODE_INTENT_ORIGINAL_ORDER

CODE_INTENT_REFLEX_ORDER

CODE_INTENT_PLAN

CODE_INTENT_ORDER

CODE_INTENT_OPTION

health.fhir.r4: MedicationRequestPriority

MedicationRequestPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r4: MedicationRequestStatus

MedicationRequestStatus enum

Members

CODE_STATUS_STOPPED

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_COMPLETED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r4: MedicationStatementStatus

MedicationStatementStatus enum

Members

CODE_STATUS_STOPPED

CODE_STATUS_INTENDED

CODE_STATUS_ACTIVE

CODE_STATUS_NOT_TAKEN

CODE_STATUS_COMPLETED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r4: MedicationStatus

MedicationStatus enum

Members

CODE_STATUS_INACTIVE

CODE_STATUS_ACTIVE

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4: MessageDefinitionCategory

MessageDefinitionCategory enum

Members

CODE_CATEGORY_NOTIFICATION

CODE_CATEGORY_CONSEQUENCE

CODE_CATEGORY_CURRENCY

health.fhir.r4: MessageDefinitionResponseRequired

MessageDefinitionResponseRequired enum

Members

CODE_RESPONSEREQUIRED_ALWAYS

CODE_RESPONSEREQUIRED_NEVER

CODE_RESPONSEREQUIRED_ON_ERROR

CODE_RESPONSEREQUIRED_ON_SUCCESS

health.fhir.r4: MessageDefinitionStatus

MessageDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: MessageDirection

Enum to indicate message flow direction

Members

OUT

health.fhir.r4: MessageHeaderResponseCode

MessageHeaderResponseCode enum

Members

CODE_CODE_FATAL_ERROR

CODE_CODE_OK

CODE_CODE_TRANSIENT_ERROR

health.fhir.r4: MolecularSequenceQualityType

MolecularSequenceQualityType enum

Members

CODE_TYPE_SNP

CODE_TYPE_INDEL

CODE_TYPE_UNKNOWN

health.fhir.r4: MolecularSequenceReferenceSeqOrientation

MolecularSequenceReferenceSeqOrientation enum

Members

CODE_ORIENTATION_SENSE

CODE_ORIENTATION_ANTISENSE

health.fhir.r4: MolecularSequenceReferenceSeqStrand

MolecularSequenceReferenceSeqStrand enum

Members

CODE_STRAND_WATSON

CODE_STRAND_CRICK

health.fhir.r4: MolecularSequenceRepositoryType

MolecularSequenceRepositoryType enum

Members

CODE_TYPE_DIRECTLINK

CODE_TYPE_OTHER

CODE_TYPE_OPENAPI

CODE_TYPE_LOGIN

CODE_TYPE_OAUTH

health.fhir.r4: MolecularSequenceType

MolecularSequenceType enum

Members

CODE_TYPE_AA

CODE_TYPE_RNA

CODE_TYPE_DNA

health.fhir.r4: NamingSystemKind

NamingSystemKind enum

Members

CODE_KIND_IDENTIFIER

CODE_KIND_CODESYSTEM

CODE_KIND_ROOT

health.fhir.r4: NamingSystemStatus

NamingSystemStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: NamingSystemUniqueIdType

NamingSystemUniqueIdType enum

Members

CODE_TYPE_OTHER

CODE_TYPE_OID

CODE_TYPE_UUID

CODE_TYPE_URI

health.fhir.r4: NutritionOrderIntent

NutritionOrderIntent enum

Members

CODE_INTENT_PROPOSAL

CODE_INTENT_INSTANCE_ORDER

CODE_INTENT_FILLER_ORDER

CODE_INTENT_ORIGINAL_ORDER

CODE_INTENT_REFLEX_ORDER

CODE_INTENT_PLAN

CODE_INTENT_DIRECTIVE

CODE_INTENT_ORDER

CODE_INTENT_OPTION

health.fhir.r4: NutritionOrderStatus

NutritionOrderStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_COMPLETED

CODE_STATUS_REVOKED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r4: ObservationDefinitionPermittedDataType

ObservationDefinitionPermittedDataType enum

Members

CODE_PERMITTEDDATATYPE_DATETIME

CODE_PERMITTEDDATATYPE_BOOLEAN

CODE_PERMITTEDDATATYPE_STRING

CODE_PERMITTEDDATATYPE_SAMPLEDDATA

CODE_PERMITTEDDATATYPE_QUANTITY

CODE_PERMITTEDDATATYPE_PERIOD

CODE_PERMITTEDDATATYPE_RATIO

CODE_PERMITTEDDATATYPE_INTEGER

CODE_PERMITTEDDATATYPE_TIME

CODE_PERMITTEDDATATYPE_RANGE

CODE_PERMITTEDDATATYPE_CODEABLECONCEPT

health.fhir.r4: ObservationDefinitionQualifiedIntervalCategory

ObservationDefinitionQualifiedIntervalCategory enum

Members

CODE_CATEGORY_REFERENCE

CODE_CATEGORY_CRITICAL

CODE_CATEGORY_ABSOLUTE

health.fhir.r4: ObservationDefinitionQualifiedIntervalGender

ObservationDefinitionQualifiedIntervalGender enum

Members

CODE_GENDER_OTHER

CODE_GENDER_FEMALE

CODE_GENDER_MALE

CODE_GENDER_UNKNOWN

health.fhir.r4: ObservationStatus

ObservationStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r4: ObservationStatusOne

ObservationStatusOne enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r4: OperationDefinitionKind

OperationDefinitionKind enum

Members

CODE_KIND_QUERY

CODE_KIND_OPERATION

health.fhir.r4: OperationDefinitionParameterBindingStrength

OperationDefinitionParameterBindingStrength enum

Members

CODE_STRENGTH_EXTENSIBLE

CODE_STRENGTH_REQUIRED

CODE_STRENGTH_PREFERRED

CODE_STRENGTH_EXAMPLE

health.fhir.r4: OperationDefinitionParameterSearchType

OperationDefinitionParameterSearchType enum

Members

CODE_SEARCHTYPE_DATE

CODE_SEARCHTYPE_REFERENCE

CODE_SEARCHTYPE_SPECIAL

CODE_SEARCHTYPE_NUMBER

CODE_SEARCHTYPE_QUANTITY

CODE_SEARCHTYPE_STRING

CODE_SEARCHTYPE_COMPOSITE

CODE_SEARCHTYPE_URI

CODE_SEARCHTYPE_TOKEN

health.fhir.r4: OperationDefinitionParameterUse

OperationDefinitionParameterUse enum

Members

CODE_USE_IN

CODE_USE_OUT

health.fhir.r4: OperationDefinitionStatus

OperationDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: OperationOutcomeIssueSeverity

OperationOutcomeIssueSeverity enum

Members

CODE_SEVERITY_WARNING

CODE_SEVERITY_INFORMATION

CODE_SEVERITY_ERROR

CODE_SEVERITY_FATAL

health.fhir.r4: ParameterDefinitionUse

Members

'in

out

health.fhir.r4: PatientContactGender

PatientContactGender enum

Members

CODE_GENDER_OTHER

CODE_GENDER_FEMALE

CODE_GENDER_MALE

CODE_GENDER_UNKNOWN

health.fhir.r4: PatientGender

PatientGender enum

Members

CODE_GENDER_OTHER

CODE_GENDER_FEMALE

CODE_GENDER_MALE

CODE_GENDER_UNKNOWN

health.fhir.r4: PatientLinkType

PatientLinkType enum

Members

CODE_TYPE_REFER

CODE_TYPE_REPLACES

CODE_TYPE_SEEALSO

CODE_TYPE_REPLACED_BY

health.fhir.r4: PaymentNoticeStatus

PaymentNoticeStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4: PaymentReconciliationOutcome

PaymentReconciliationOutcome enum

Members

CODE_OUTCOME_QUEUED

CODE_OUTCOME_COMPLETE

CODE_OUTCOME_ERROR

CODE_OUTCOME_PARTIAL

health.fhir.r4: PaymentReconciliationProcessNoteType

PaymentReconciliationProcessNoteType enum

Members

CODE_TYPE_PRINT

CODE_TYPE_DISPLAY

CODE_TYPE_PRINTOPER

health.fhir.r4: PaymentReconciliationStatus

PaymentReconciliationStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4: PersonGender

PersonGender enum

Members

CODE_GENDER_OTHER

CODE_GENDER_FEMALE

CODE_GENDER_MALE

CODE_GENDER_UNKNOWN

health.fhir.r4: PersonLinkAssurance

PersonLinkAssurance enum

Members

CODE_ASSURANCE_LEVEL4

CODE_ASSURANCE_LEVEL1

CODE_ASSURANCE_LEVEL3

CODE_ASSURANCE_LEVEL2

health.fhir.r4: PlanDefinitionActionCardinalityBehavior

PlanDefinitionActionCardinalityBehavior enum

Members

CODE_CARDINALITYBEHAVIOR_SINGLE

CODE_CARDINALITYBEHAVIOR_MULTIPLE

health.fhir.r4: PlanDefinitionActionConditionKind

PlanDefinitionActionConditionKind enum

Members

CODE_KIND_STOP

CODE_KIND_START

CODE_KIND_APPLICABILITY

health.fhir.r4: PlanDefinitionActionGroupingBehavior

PlanDefinitionActionGroupingBehavior enum

Members

CODE_GROUPINGBEHAVIOR_VISUAL_GROUP

CODE_GROUPINGBEHAVIOR_SENTENCE_GROUP

CODE_GROUPINGBEHAVIOR_LOGICAL_GROUP

health.fhir.r4: PlanDefinitionActionParticipantType

PlanDefinitionActionParticipantType enum

Members

CODE_TYPE_RELATED_PERSON

CODE_TYPE_PRACTITIONER

CODE_TYPE_PATIENT

CODE_TYPE_DEVICE

health.fhir.r4: PlanDefinitionActionPrecheckBehavior

PlanDefinitionActionPrecheckBehavior enum

Members

CODE_PRECHECKBEHAVIOR_NO

CODE_PRECHECKBEHAVIOR_YES

health.fhir.r4: PlanDefinitionActionPriority

PlanDefinitionActionPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r4: PlanDefinitionActionRelatedActionRelationship

PlanDefinitionActionRelatedActionRelationship enum

Members

CODE_RELATIONSHIP_AFTER_END

CODE_RELATIONSHIP_BEFORE

CODE_RELATIONSHIP_CONCURRENT_WITH_START

CODE_RELATIONSHIP_CONCURRENT

CODE_RELATIONSHIP_BEFORE_END

CODE_RELATIONSHIP_AFTER

CODE_RELATIONSHIP_CONCURRENT_WITH_END

CODE_RELATIONSHIP_AFTER_START

CODE_RELATIONSHIP_BEFORE_START

health.fhir.r4: PlanDefinitionActionRequiredBehavior

PlanDefinitionActionRequiredBehavior enum

Members

CODE_REQUIREDBEHAVIOR_COULD

CODE_REQUIREDBEHAVIOR_MUST

CODE_REQUIREDBEHAVIOR_MUST_UNLESS_DOCUMENTED

health.fhir.r4: PlanDefinitionActionSelectionBehavior

PlanDefinitionActionSelectionBehavior enum

Members

CODE_SELECTIONBEHAVIOR_ALL

CODE_SELECTIONBEHAVIOR_EXACTLY_ONE

CODE_SELECTIONBEHAVIOR_AT_MOST_ONE

CODE_SELECTIONBEHAVIOR_ALL_OR_NONE

CODE_SELECTIONBEHAVIOR_ANY

CODE_SELECTIONBEHAVIOR_ONE_OR_MORE

health.fhir.r4: PlanDefinitionStatus

PlanDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: PractitionerGender

PractitionerGender enum

Members

CODE_GENDER_OTHER

CODE_GENDER_FEMALE

CODE_GENDER_MALE

CODE_GENDER_UNKNOWN

health.fhir.r4: PractitionerRoleAvailableTimeDaysOfWeek

PractitionerRoleAvailableTimeDaysOfWeek enum

Members

CODE_DAYSOFWEEK_THU

CODE_DAYSOFWEEK_TUE

CODE_DAYSOFWEEK_WED

CODE_DAYSOFWEEK_SAT

CODE_DAYSOFWEEK_FRI

CODE_DAYSOFWEEK_MON

CODE_DAYSOFWEEK_SUN

health.fhir.r4: Prefix

For the ordered parameter types of number, date, and quantity, a prefix to the parameter value may be used to control the nature of the matching

Members

health.fhir.r4: ProcedureStatus

ProcedureStatus enum

Members

CODE_STATUS_STOPPED

CODE_STATUS_COMPLETED

CODE_STATUS_NOT_DONE

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

CODE_STATUS_ON_HOLD

CODE_STATUS_PREPARATION

CODE_STATUS_UNKNOWN

health.fhir.r4: ProvenanceEntityRole

ProvenanceEntityRole enum

Members

CODE_ROLE_REMOVAL

CODE_ROLE_DERIVATION

CODE_ROLE_SOURCE

CODE_ROLE_QUOTATION

CODE_ROLE_REVISION

health.fhir.r4: QuantityComparatorCode

Members

LESS_THAN

LESS_THAN_EQUAL

GREATER_THAN_EQUAL

GREATER_THAN

health.fhir.r4: QuestionnaireItemEnableBehavior

QuestionnaireItemEnableBehavior enum

Members

CODE_ENABLEBEHAVIOR_ALL

CODE_ENABLEBEHAVIOR_ANY

health.fhir.r4: QuestionnaireItemEnableWhenOperator

QuestionnaireItemEnableWhenOperator enum

Members

CODE_OPERATOR_LESS_THAN_OR_EQUAL

CODE_OPERATOR_EXISTS

CODE_OPERATOR_NOT_EQUAL

CODE_OPERATOR_LESS_THAN

CODE_OPERATOR_EQUAL

CODE_OPERATOR_GREATER_THAN

CODE_OPERATOR_GREATER_THAN_OR_EQUAL

health.fhir.r4: QuestionnaireItemType

QuestionnaireItemType enum

Members

CODE_TYPE_DATE

CODE_TYPE_DATETIME

CODE_TYPE_BOOLEAN

CODE_TYPE_DISPLAY

CODE_TYPE_INTEGER

CODE_TYPE_DECIMAL

CODE_TYPE_GROUP

health.fhir.r4: QuestionnaireResponseStatus

QuestionnaireResponseStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_STOPPED

CODE_STATUS_COMPLETED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

health.fhir.r4: QuestionnaireStatus

QuestionnaireStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: RelatedPersonGender

RelatedPersonGender enum

Members

CODE_GENDER_OTHER

CODE_GENDER_FEMALE

CODE_GENDER_MALE

CODE_GENDER_UNKNOWN

health.fhir.r4: RepeatCode

Members

BID

TID

QID

QOD

Q1H

Q2H

Q3H

Q4H

Q6H

Q8H

BED

health.fhir.r4: RequestGroupActionCardinalityBehavior

RequestGroupActionCardinalityBehavior enum

Members

CODE_CARDINALITYBEHAVIOR_SINGLE

CODE_CARDINALITYBEHAVIOR_MULTIPLE

health.fhir.r4: RequestGroupActionConditionKind

RequestGroupActionConditionKind enum

Members

CODE_KIND_STOP

CODE_KIND_START

CODE_KIND_APPLICABILITY

health.fhir.r4: RequestGroupActionGroupingBehavior

RequestGroupActionGroupingBehavior enum

Members

CODE_GROUPINGBEHAVIOR_VISUAL_GROUP

CODE_GROUPINGBEHAVIOR_SENTENCE_GROUP

CODE_GROUPINGBEHAVIOR_LOGICAL_GROUP

health.fhir.r4: RequestGroupActionPrecheckBehavior

RequestGroupActionPrecheckBehavior enum

Members

CODE_PRECHECKBEHAVIOR_NO

CODE_PRECHECKBEHAVIOR_YES

health.fhir.r4: RequestGroupActionPriority

RequestGroupActionPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r4: RequestGroupActionRelatedActionRelationship

RequestGroupActionRelatedActionRelationship enum

Members

CODE_RELATIONSHIP_AFTER_END

CODE_RELATIONSHIP_BEFORE

CODE_RELATIONSHIP_CONCURRENT_WITH_START

CODE_RELATIONSHIP_CONCURRENT

CODE_RELATIONSHIP_BEFORE_END

CODE_RELATIONSHIP_AFTER

CODE_RELATIONSHIP_CONCURRENT_WITH_END

CODE_RELATIONSHIP_AFTER_START

CODE_RELATIONSHIP_BEFORE_START

health.fhir.r4: RequestGroupActionRequiredBehavior

RequestGroupActionRequiredBehavior enum

Members

CODE_REQUIREDBEHAVIOR_COULD

CODE_REQUIREDBEHAVIOR_MUST

CODE_REQUIREDBEHAVIOR_MUST_UNLESS_DOCUMENTED

health.fhir.r4: RequestGroupActionSelectionBehavior

RequestGroupActionSelectionBehavior enum

Members

CODE_SELECTIONBEHAVIOR_ALL

CODE_SELECTIONBEHAVIOR_EXACTLY_ONE

CODE_SELECTIONBEHAVIOR_AT_MOST_ONE

CODE_SELECTIONBEHAVIOR_ALL_OR_NONE

CODE_SELECTIONBEHAVIOR_ANY

CODE_SELECTIONBEHAVIOR_ONE_OR_MORE

health.fhir.r4: RequestGroupIntent

RequestGroupIntent enum

Members

CODE_INTENT_PROPOSAL

CODE_INTENT_INSTANCE_ORDER

CODE_INTENT_FILLER_ORDER

CODE_INTENT_ORIGINAL_ORDER

CODE_INTENT_REFLEX_ORDER

CODE_INTENT_PLAN

CODE_INTENT_DIRECTIVE

CODE_INTENT_ORDER

CODE_INTENT_OPTION

health.fhir.r4: RequestGroupPriority

RequestGroupPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r4: RequestGroupStatus

RequestGroupStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_COMPLETED

CODE_STATUS_REVOKED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r4: ResearchDefinitionStatus

ResearchDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: ResearchElementDefinitionCharacteristicParticipantEffectiveGroupMeasure

ResearchElementDefinitionCharacteristicParticipantEffectiveGroupMeasure enum

Members

CODE_PARTICIPANTEFFECTIVEGROUPMEASURE_MEAN_OF_MEDIAN

CODE_PARTICIPANTEFFECTIVEGROUPMEASURE_MEDIAN

CODE_PARTICIPANTEFFECTIVEGROUPMEASURE_MEAN

CODE_PARTICIPANTEFFECTIVEGROUPMEASURE_MEDIAN_OF_MEDIAN

CODE_PARTICIPANTEFFECTIVEGROUPMEASURE_MEDIAN_OF_MEAN

CODE_PARTICIPANTEFFECTIVEGROUPMEASURE_MEAN_OF_MEAN

health.fhir.r4: ResearchElementDefinitionCharacteristicStudyEffectiveGroupMeasure

ResearchElementDefinitionCharacteristicStudyEffectiveGroupMeasure enum

Members

CODE_STUDYEFFECTIVEGROUPMEASURE_MEAN_OF_MEDIAN

CODE_STUDYEFFECTIVEGROUPMEASURE_MEDIAN

CODE_STUDYEFFECTIVEGROUPMEASURE_MEAN

CODE_STUDYEFFECTIVEGROUPMEASURE_MEDIAN_OF_MEDIAN

CODE_STUDYEFFECTIVEGROUPMEASURE_MEDIAN_OF_MEAN

CODE_STUDYEFFECTIVEGROUPMEASURE_MEAN_OF_MEAN

health.fhir.r4: ResearchElementDefinitionStatus

ResearchElementDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: ResearchElementDefinitionType

ResearchElementDefinitionType enum

Members

CODE_TYPE_EXPOSURE

CODE_TYPE_OUTCOME

CODE_TYPE_POPULATION

health.fhir.r4: ResearchElementDefinitionVariableType

ResearchElementDefinitionVariableType enum

Members

CODE_VARIABLETYPE_CONTINUOUS

CODE_VARIABLETYPE_DESCRIPTIVE

CODE_VARIABLETYPE_DICHOTOMOUS

health.fhir.r4: ResearchStudyStatus

ResearchStudyStatus enum

Members

CODE_STATUS_CLOSED_TO_ACCRUAL_AND_INTERVENTION

CODE_STATUS_APPROVED

CODE_STATUS_ADMINISTRATIVELY_COMPLETED

CODE_STATUS_WITHDRAWN

CODE_STATUS_ACTIVE

CODE_STATUS_IN_REVIEW

CODE_STATUS_TEMPORARILY_CLOSED_TO_ACCRUAL

CODE_STATUS_CLOSED_TO_ACCRUAL

CODE_STATUS_COMPLETED

CODE_STATUS_DISAPPROVED

CODE_STATUS_TEMPORARILY_CLOSED_TO_ACCRUAL_AND_INTERVENTION

health.fhir.r4: ResearchSubjectStatus

ResearchSubjectStatus enum

Members

CODE_STATUS_SCREENING

CODE_STATUS_NOT_REGISTERED

CODE_STATUS_PENDING_ON_STUDY

CODE_STATUS_WITHDRAWN

CODE_STATUS_POTENTIAL_CANDIDATE

CODE_STATUS_ON_STUDY_INTERVENTION

CODE_STATUS_FOLLOW_UP

CODE_STATUS_ON_STUDY_OBSERVATION

CODE_STATUS_CANDIDATE

CODE_STATUS_INELIGIBLE

CODE_STATUS_ELIGIBLE

CODE_STATUS_ON_STUDY

CODE_STATUS_OFF_STUDY

health.fhir.r4: RiskAssessmentStatus

RiskAssessmentStatus enum

Members

CODE_STATUS_AMENDED

CODE_STATUS_FINAL

CODE_STATUS_REGISTERED

CODE_STATUS_PRELIMINARY

health.fhir.r4: RiskEvidenceSynthesisStatus

RiskEvidenceSynthesisStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: SearchEntryMode

Members

MATCH

INCLUDE

OUTCOME

health.fhir.r4: SearchParameterComparator

SearchParameterComparator enum

Members

CODE_COMPARATOR_NE

CODE_COMPARATOR_LT

CODE_COMPARATOR_LE

CODE_COMPARATOR_EQ

CODE_COMPARATOR_GT

CODE_COMPARATOR_EB

CODE_COMPARATOR_GE

CODE_COMPARATOR_SA

CODE_COMPARATOR_AP

health.fhir.r4: SearchParameterModifier

SearchParameterModifier enum

Members

CODE_MODIFIER_IDENTIFIER

CODE_MODIFIER_CONTAINS

CODE_MODIFIER_NOT

CODE_MODIFIER_IN

CODE_MODIFIER_BELOW

CODE_MODIFIER_MISSING

CODE_MODIFIER_EXACT

CODE_MODIFIER_ABOVE

CODE_MODIFIER_NOT_IN

CODE_MODIFIER_TEXT

CODE_MODIFIER_TYPE

CODE_MODIFIER_OFTYPE

health.fhir.r4: SearchParameterStatus

SearchParameterStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: SearchParameterType

SearchParameterType enum

Members

CODE_TYPE_DATE

CODE_TYPE_REFERENCE

CODE_TYPE_SPECIAL

CODE_TYPE_NUMBER

CODE_TYPE_QUANTITY

CODE_TYPE_STRING

CODE_TYPE_COMPOSITE

CODE_TYPE_URI

CODE_TYPE_TOKEN

health.fhir.r4: SearchParameterXpathUsage

SearchParameterXpathUsage enum

Members

CODE_XPATHUSAGE_NORMAL

CODE_XPATHUSAGE_OTHER

CODE_XPATHUSAGE_PHONETIC

CODE_XPATHUSAGE_DISTANCE

CODE_XPATHUSAGE_NEARBY

health.fhir.r4: ServiceRequestIntent

ServiceRequestIntent enum

Members

CODE_INTENT_PROPOSAL

CODE_INTENT_INSTANCE_ORDER

CODE_INTENT_FILLER_ORDER

CODE_INTENT_ORIGINAL_ORDER

CODE_INTENT_REFLEX_ORDER

CODE_INTENT_PLAN

CODE_INTENT_DIRECTIVE

CODE_INTENT_ORDER

CODE_INTENT_OPTION

health.fhir.r4: ServiceRequestPriority

ServiceRequestPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r4: ServiceRequestStatus

ServiceRequestStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_COMPLETED

CODE_STATUS_REVOKED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_ON_HOLD

CODE_STATUS_UNKNOWN

health.fhir.r4: Severity

Level the issue affects the success of the action.

Members

FATAL

ERROR

WARNING

INFORMATION

health.fhir.r4: SlotStatus

SlotStatus enum

Members

CODE_STATUS_BUSY_UNAVAILABLE

CODE_STATUS_BUSY

CODE_STATUS_BUSY_TENTATIVE

CODE_STATUS_FREE

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4: SpecimenDefinitionTypeTestedPreference

SpecimenDefinitionTypeTestedPreference enum

Members

CODE_PREFERENCE_ALTERNATE

CODE_PREFERENCE_PREFERRED

health.fhir.r4: SpecimenStatus

SpecimenStatus enum

Members

CODE_STATUS_UNAVAILABLE

CODE_STATUS_AVAILABLE

CODE_STATUS_UNSATISFACTORY

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4: StatusCode

Members

generated

extensions

additional

empty

health.fhir.r4: StrengthCode

Members

required

extensible

preferred

example

health.fhir.r4: StructureDefinitionContextType

StructureDefinitionContextType enum

Members

CODE_TYPE_EXTENSION

CODE_TYPE_FHIRPATH

CODE_TYPE_ELEMENT

health.fhir.r4: StructureDefinitionDerivation

StructureDefinitionDerivation enum

Members

CODE_DERIVATION_SPECIALIZATION

CODE_DERIVATION_CONSTRAINT

health.fhir.r4: StructureDefinitionKind

StructureDefinitionKind enum

Members

CODE_KIND_PRIMITIVE_TYPE

CODE_KIND_RESOURCE

CODE_KIND_COMPLEX_TYPE

CODE_KIND_LOGICAL

health.fhir.r4: StructureDefinitionStatus

StructureDefinitionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: StructureMapGroupInputMode

StructureMapGroupInputMode enum

Members

CODE_MODE_SOURCE

CODE_MODE_TARGET

health.fhir.r4: StructureMapGroupRuleSourceListMode

StructureMapGroupRuleSourceListMode enum

Members

CODE_LISTMODE_ONLY_ONE

CODE_LISTMODE_LAST

CODE_LISTMODE_NOT_LAST

CODE_LISTMODE_NOT_FIRST

CODE_LISTMODE_FIRST

health.fhir.r4: StructureMapGroupRuleTargetContextType

StructureMapGroupRuleTargetContextType enum

Members

CODE_CONTEXTTYPE_VARIABLE

CODE_CONTEXTTYPE_TYPE

health.fhir.r4: StructureMapGroupRuleTargetListMode

StructureMapGroupRuleTargetListMode enum

Members

CODE_LISTMODE_COLLATE

CODE_LISTMODE_LAST

CODE_LISTMODE_SHARE

CODE_LISTMODE_FIRST

health.fhir.r4: StructureMapGroupRuleTargetTransform

StructureMapGroupRuleTargetTransform enum

Members

CODE_TRANSFORM_CREATE

CODE_TRANSFORM_COPY

health.fhir.r4: StructureMapGroupTypeMode

StructureMapGroupTypeMode enum

Members

CODE_TYPEMODE_TYPES

CODE_TYPEMODE_NONE

CODE_TYPEMODE_TYPE_AND_TYPES

health.fhir.r4: StructureMapStatus

StructureMapStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: StructureMapStructureMode

StructureMapStructureMode enum

Members

CODE_MODE_SOURCE

CODE_MODE_QUERIED

CODE_MODE_TARGET

CODE_MODE_PRODUCED

health.fhir.r4: SubscriptionChannelType

SubscriptionChannelType enum

Members

CODE_TYPE_REST_HOOK

CODE_TYPE_WEBSOCKET

CODE_TYPE_SMS

CODE_TYPE_MESSAGE

CODE_TYPE_EMAIL

health.fhir.r4: SubscriptionStatus

SubscriptionStatus enum

Members

CODE_STATUS_REQUESTED

CODE_STATUS_ACTIVE

CODE_STATUS_ERROR

CODE_STATUS_OFF

health.fhir.r4: SubstanceStatus

SubstanceStatus enum

Members

CODE_STATUS_INACTIVE

CODE_STATUS_ACTIVE

CODE_STATUS_ENTERED_IN_ERROR

health.fhir.r4: SupplyDeliveryStatus

SupplyDeliveryStatus enum

Members

CODE_STATUS_COMPLETED

CODE_STATUS_ABANDONED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

health.fhir.r4: SupplyRequestPriority

SupplyRequestPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r4: SupplyRequestStatus

SupplyRequestStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_SUSPENDED

health.fhir.r4: TaskIntent

TaskIntent enum

Members

CODE_INTENT_PROPOSAL

CODE_INTENT_INSTANCE_ORDER

CODE_INTENT_FILLER_ORDER

CODE_INTENT_ORIGINAL_ORDER

CODE_INTENT_REFLEX_ORDER

CODE_INTENT_PLAN

CODE_INTENT_UNKNOWN

CODE_INTENT_ORDER

CODE_INTENT_OPTION

health.fhir.r4: TaskPriority

TaskPriority enum

Members

CODE_PRIORITY_STAT

CODE_PRIORITY_ROUTINE

CODE_PRIORITY_URGENT

CODE_PRIORITY_ASAP

health.fhir.r4: TaskStatus

TaskStatus enum

Members

CODE_STATUS_REQUESTED

CODE_STATUS_DRAFT

CODE_STATUS_ACCEPTED

CODE_STATUS_RECEIVED

health.fhir.r4: TerminologyCapabilitiesCodeSearch

TerminologyCapabilitiesCodeSearch enum

Members

CODE_CODESEARCH_EXPLICIT

CODE_CODESEARCH_ALL

health.fhir.r4: TerminologyCapabilitiesKind

TerminologyCapabilitiesKind enum

Members

CODE_KIND_CAPABILITY

CODE_KIND_REQUIREMENTS

CODE_KIND_INSTANCE

health.fhir.r4: TerminologyCapabilitiesStatus

TerminologyCapabilitiesStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: TestReportParticipantType

TestReportParticipantType enum

Members

CODE_TYPE_SERVER

CODE_TYPE_CLIENT

CODE_TYPE_TEST_ENGINE

health.fhir.r4: TestReportResult

TestReportResult enum

Members

CODE_RESULT_FAIL

CODE_RESULT_PASS

CODE_RESULT_PENDING

health.fhir.r4: TestReportSetupActionAssertResult

TestReportSetupActionAssertResult enum

Members

CODE_RESULT_FAIL

CODE_RESULT_PASS

CODE_RESULT_WARNING

CODE_RESULT_SKIP

CODE_RESULT_ERROR

health.fhir.r4: TestReportSetupActionOperationResult

TestReportSetupActionOperationResult enum

Members

CODE_RESULT_FAIL

CODE_RESULT_PASS

CODE_RESULT_WARNING

CODE_RESULT_SKIP

CODE_RESULT_ERROR

health.fhir.r4: TestReportStatus

TestReportStatus enum

Members

CODE_STATUS_STOPPED

CODE_STATUS_WAITING

CODE_STATUS_COMPLETED

CODE_STATUS_ENTERED_IN_ERROR

CODE_STATUS_IN_PROGRESS

health.fhir.r4: TestScriptSetupActionAssertDirection

TestScriptSetupActionAssertDirection enum

Members

CODE_DIRECTION_REQUEST

CODE_DIRECTION_RESPONSE

health.fhir.r4: TestScriptSetupActionAssertOperator

TestScriptSetupActionAssertOperator enum

Members

CODE_OPERATOR_CONTAINS

CODE_OPERATOR_EVAL

CODE_OPERATOR_IN

CODE_OPERATOR_NOTCONTAINS

CODE_OPERATOR_EQUALS

CODE_OPERATOR_LESSTHAN

CODE_OPERATOR_NOTEQUALS

CODE_OPERATOR_NOTIN

CODE_OPERATOR_NOTEMPTY

CODE_OPERATOR_GREATERTHAN

CODE_OPERATOR_EMPTY

health.fhir.r4: TestScriptSetupActionAssertRequestMethod

TestScriptSetupActionAssertRequestMethod enum

Members

CODE_REQUESTMETHOD_PATCH

CODE_REQUESTMETHOD_HEAD

CODE_REQUESTMETHOD_POST

CODE_REQUESTMETHOD_GET

CODE_REQUESTMETHOD_OPTIONS

CODE_REQUESTMETHOD_DELETE

CODE_REQUESTMETHOD_PUT

health.fhir.r4: TestScriptSetupActionAssertResponse

TestScriptSetupActionAssertResponse enum

Members

CODE_RESPONSE_OKAY

CODE_RESPONSE_NOCONTENT

CODE_RESPONSE_BAD

CODE_RESPONSE_NOTMODIFIED

CODE_RESPONSE_CREATED

CODE_RESPONSE_FORBIDDEN

CODE_RESPONSE_METHODNOTALLOWED

CODE_RESPONSE_NOTFOUND

CODE_RESPONSE_PRECONDITIONFAILED

CODE_RESPONSE_UNPROCESSABLE

CODE_RESPONSE_CONFLICT

CODE_RESPONSE_GONE

health.fhir.r4: TestScriptSetupActionOperationMethod

TestScriptSetupActionOperationMethod enum

Members

CODE_METHOD_PATCH

CODE_METHOD_HEAD

CODE_METHOD_POST

CODE_METHOD_GET

CODE_METHOD_OPTIONS

CODE_METHOD_DELETE

CODE_METHOD_PUT

health.fhir.r4: TestScriptStatus

TestScriptStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: Timecode

Members

min

health.fhir.r4: TypeAggregation

Members

contained

referenced

bundled

health.fhir.r4: TypeVersioning

Members

either

independent

specific

health.fhir.r4: ValueSetComposeIncludeFilterOp

ValueSetComposeIncludeFilterOp enum

Members

CODE_OP_IS_NOT_A

CODE_OP_REGEX

CODE_OP_IN

CODE_OP_DESCENDENT_OF

CODE_OP_NOT_IN

CODE_OP_EXISTS

CODE_OP_GENERALIZES

CODE_OP_EQUAL

CODE_OP_IS_A

health.fhir.r4: ValueSetStatus

ValueSetStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_RETIRED

CODE_STATUS_UNKNOWN

health.fhir.r4: VerificationResultStatus

VerificationResultStatus enum

Members

CODE_STATUS_VALIDATED

CODE_STATUS_VAL_FAIL

CODE_STATUS_ATTESTED

CODE_STATUS_REQ_REVALID

CODE_STATUS_REVAL_FAIL

CODE_STATUS_IN_PROCESS

health.fhir.r4: VisionPrescriptionLensSpecificationEye

VisionPrescriptionLensSpecificationEye enum

Members

CODE_EYE_LEFT

CODE_EYE_RIGHT

health.fhir.r4: VisionPrescriptionLensSpecificationPrismBase

VisionPrescriptionLensSpecificationPrismBase enum

Members

CODE_BASE_IN

CODE_BASE_UP

CODE_BASE_DOWN

CODE_BASE_OUT

health.fhir.r4: VisionPrescriptionStatus

VisionPrescriptionStatus enum

Members

CODE_STATUS_DRAFT

CODE_STATUS_ACTIVE

CODE_STATUS_CANCELLED

CODE_STATUS_ENTERED_IN_ERROR

Variables

health.fhir.r4: terminologyProcessor

TerminologyProcessor(default TerminologyProcessor)

Terminology processor instance

health.fhir.r4: fhirRegistry

FHIRRegistry(default FHIRRegistry)

FHIR registry instance

health.fhir.r4: FHIR_VALUE_SETS

json[](default [])

health.fhir.r4: FHIR_CODE_SYSTEMS

json[](default [])

Annotations

health.fhir.r4: ContainerDefinition

ContainerDefinitionRecord

type

health.fhir.r4: DataTypeDefinition

DataTypeDefinitionRecord

type

health.fhir.r4: ResourceDefinition

ResourceDefinitionRecord

type

Records

health.fhir.r4: Account

FHIR Account resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_ACCOUNT(default RESOURCE_NAME_ACCOUNT) - The type of the resource describes

meta BaseAccountMeta(default { profile : [PROFILE_BASE_ACCOUNT] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

coverage AccountCoverage[]? - The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.

owner Reference? - Indicates the service area, hospital, department, etc. with responsibility for managing the Account.

identifier Identifier[]? - Unique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number).

partOf Reference? - Reference to a parent Account.

extension Extension[]? - 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.

subject Reference[]? - Identifies the entity which incurs the expenses. While the immediate recipients of services or goods might be entities related to the subject, the expenses were ultimately incurred by the subject of the Account.

modifierExtension Extension[]? - 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).

description string? - Provides additional information about what the account tracks and how it is used.

guarantor AccountGuarantor[]? - The parties responsible for balancing the account if other payment options fall short.

language code? - The base language in which the resource is written.

'type CodeableConcept? - Categorizes the account for reporting and searching purposes.

servicePeriod Period? - The date range of services associated with this account.

contained Resource[]? - 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.

name string? - Name used for the account when displaying it to humans in reports, etc.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

status AccountStatus - Indicates whether the account is presently used/usable or not.

never... - Rest field

health.fhir.r4: AccountCoverage

Closed record

FHIR AccountCoverage datatype record.

Fields

coverage Reference - The party(s) that contribute to payment (or part of) of the charges applied to this account (including self-pay). A coverage may only be responsible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

priority positiveInt? - The priority of the coverage in the context of this account.

health.fhir.r4: AccountGuarantor

Closed record

FHIR AccountGuarantor datatype record.

Fields

extension Extension[]? - 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.

period Period? - The timeframe during which the guarantor accepts responsibility for the account.

onHold boolean? - A guarantor may be placed on credit hold or otherwise have their role temporarily suspended.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

party Reference - The entity who is responsible.

health.fhir.r4: ActivityDefinition

FHIR ActivityDefinition resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_ACTIVITYDEFINITION(default RESOURCE_NAME_ACTIVITYDEFINITION) - The type of the resource describes

meta BaseActivityDefinitionMeta(default { profile : [PROFILE_BASE_ACTIVITYDEFINITION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime? - The date (and optionally time) when the activity definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes.

copyright markdown? - A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.

modifierExtension Extension[]? - 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).

usage string? - A detailed description of how the activity definition is used from a clinical perspective.

productReference Reference? - Identifies the food, drug or other product being consumed or supplied in the activity.

experimental boolean? - A Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language code? - The base language in which the resource is written.

participant ActivityDefinitionParticipant[]? - Indicates who should participate in performing the action described.

observationResultRequirement Reference[]? - Defines the observations that are expected to be produced by the action.

contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.

endorser ContactDetail[]? - An individual or organization responsible for officially endorsing the content for use in some setting.

timingAge Age? - The period, timing or frequency upon which the described activity is to occur.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

doNotPerform boolean? - Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.

timingDuration Duration? - The period, timing or frequency upon which the described activity is to occur.

identifier Identifier[]? - A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

relatedArtifact RelatedArtifact[]? - Related artifacts such as additional documentation, justification, or bibliographic references.

effectivePeriod Period? - The period during which the activity definition content was or is planned to be in active use.

author ContactDetail[]? - An individiual or organization primarily involved in the creation and maintenance of the content.

kind code? - A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.

profile canonical? - A profile to which the target of the activity definition is expected to conform.

priority ActivityDefinitionPriority? - Indicates how quickly the activity should be addressed with respect to other requests.

'version string? - The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.

timingRange Range? - The period, timing or frequency upon which the described activity is to occur.

lastReviewDate date? - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

subtitle string? - An explanatory or alternate title for the activity definition giving additional information about its content.

name string? - A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher string? - The name of the organization or individual that published the activity definition.

topic CodeableConcept[]? - Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.

useContext UsageContext[]? - 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 activity definition instances.

productCodeableConcept CodeableConcept? - Identifies the food, drug or other product being consumed or supplied in the activity.

status ActivityDefinitionStatus - The status of this activity definition. Enables tracking the life-cycle of the content.

dosage Dosage[]? - Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.

extension Extension[]? - 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.

approvalDate date? - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

code CodeableConcept? - Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.

subjectCodeableConcept CodeableConcept? - A code or group definition that describes the intended subject of the activity being defined.

purpose markdown? - Explanation of why this activity definition is needed and why it has been designed as it has.

jurisdiction CodeableConcept[]? - A legal or geographic region in which the activity definition is intended to be used.

description markdown? - A free text natural language description of the activity definition from a consumer's perspective.

specimenRequirement Reference[]? - Defines specimen requirements for the action to be performed, such as required specimens for a lab test.

title string? - A short, descriptive, user-friendly title for the activity definition.

transform canonical? - A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

dynamicValue ActivityDefinitionDynamicValue[]? - Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.

library canonical[]? - A reference to a Library resource containing any formal logic used by the activity definition.

editor ContactDetail[]? - An individual or organization primarily responsible for internal coherence of the content.

quantity Quantity? - Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).

timingTiming Timing? - The period, timing or frequency upon which the described activity is to occur.

timingPeriod Period? - The period, timing or frequency upon which the described activity is to occur.

reviewer ContactDetail[]? - An individual or organization primarily responsible for review of some aspect of the content.

intent ActivityDefinitionIntent? - Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.

subjectReference Reference? - A code or group definition that describes the intended subject of the activity being defined.

observationRequirement Reference[]? - Defines observation requirements for the action to be performed, such as body weight or surface area.

url uri? - An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.

bodySite CodeableConcept[]? - Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).

contained Resource[]? - 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.

location Reference? - Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.

timingDateTime dateTime? - The period, timing or frequency upon which the described activity is to occur.

never... - Rest field

health.fhir.r4: ActivityDefinitionDynamicValue

Closed record

FHIR ActivityDefinitionDynamicValue datatype record.

Fields

path string - The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

extension Extension[]? - 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.

expression Expression - An expression specifying the value of the customized element.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ActivityDefinitionParticipant

Closed record

FHIR ActivityDefinitionParticipant datatype record.

Fields

extension Extension[]? - 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.

role CodeableConcept? - The role the participant should play in performing the described action.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type ActivityDefinitionParticipantType - The type of participant in the action.

health.fhir.r4: Address

Closed record

An address expressed using postal conventions

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - id for the element

extension Extension[]? - Extensions for the element

use AddressUse? - [home | work | temp | old | billing] - purpose of this address AddressUse (Required) (http://hl7.org/fhir/valueset-address-use.html)

'type AddressType? - [postal | physical | both] AddressType (Required) (http://hl7.org/fhir/valueset-address-type.html)

text string? - Text representation of the address

line string[]? - Street name, number, direction & P.O. Box etc.

city string? - Name of city, town etc.

district string? - District name (aka county)

state string? - Sub-unit of country (abbreviations ok)

postalCode string? - Postal code for area

country string? - Country (e.g. can be ISO 3166 2 or 3 letter code)

period Period? - Time period when address was/is in use

health.fhir.r4: AddressExtension

Closed record

Fields

url uri -

valueAddress Address -

health.fhir.r4: AdverseEvent

FHIR AdverseEvent resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_ADVERSEEVENT(default RESOURCE_NAME_ADVERSEEVENT) - The type of the resource describes

meta BaseAdverseEventMeta(default { profile : [PROFILE_BASE_ADVERSEEVENT] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime? - The date (and perhaps time) when the adverse event occurred.

extension Extension[]? - 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.

study Reference[]? - AdverseEvent.study.

subjectMedicalHistory Reference[]? - AdverseEvent.subjectMedicalHistory.

subject Reference - This subject or group impacted by the event.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

contributor Reference[]? - Parties that may or should contribute or have contributed information to the adverse event, which can consist of one or more activities. Such information includes information leading to the decision to perform the activity and how to perform the activity (e.g. consultant), information that the activity itself seeks to reveal (e.g. informant of clinical history), or information about what activity was performed (e.g. informant witness).

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

event CodeableConcept? - This element defines the specific type of event that occurred or that was prevented from occurring.

outcome CodeableConcept? - Describes the type of outcome from the adverse event.

severity CodeableConcept? - Describes the severity of the adverse event, in relation to the subject. Contrast to AdverseEvent.seriousness - a severe rash might not be serious, but a mild heart problem is.

identifier Identifier? - Business identifiers assigned to this adverse event by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

recorder Reference? - Information on who recorded the adverse event. May be the patient or a practitioner.

actuality AdverseEventActuality - Whether the event actually happened, or just had the potential to. Note that this is independent of whether anyone was affected or harmed or how severely.

recordedDate dateTime? - The date on which the existence of the AdverseEvent was first recorded.

referenceDocument Reference[]? - AdverseEvent.referenceDocument.

encounter Reference? - The Encounter during which AdverseEvent was created or to which the creation of this record is tightly associated.

suspectEntity AdverseEventSuspectEntity[]? - Describes the entity that is suspected to have caused the adverse event.

contained Resource[]? - 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.

resultingCondition Reference[]? - Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).

seriousness CodeableConcept? - Assessment whether this event was of real importance.

detected dateTime? - Estimated or actual date the AdverseEvent began, in the opinion of the reporter.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

location Reference? - The information about where the adverse event occurred.

category CodeableConcept[]? - The overall type of event, intended for search and filtering purposes.

never... - Rest field

health.fhir.r4: AdverseEventSuspectEntity

Closed record

FHIR AdverseEventSuspectEntity datatype record.

Fields

extension Extension[]? - 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.

instance Reference - Identifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

causality AdverseEventSuspectEntityCausality[]? - Information on the possible cause of the event.

health.fhir.r4: AdverseEventSuspectEntityCausality

Closed record

FHIR AdverseEventSuspectEntityCausality datatype record.

Fields

assessment CodeableConcept? - Assessment of if the entity caused the event.

extension Extension[]? - 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.

productRelatedness string? - AdverseEvent.suspectEntity.causalityProductRelatedness.

method CodeableConcept? - ProbabilityScale | Bayesian | Checklist.

author Reference? - AdverseEvent.suspectEntity.causalityAuthor.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: Age

Closed record

Fields

Fields Included from *Quantity

id string
extension Extension[]
value decimal
comparator QuantityComparatorCode
unit string
system uri
code code
Element...

id string? -

extension Extension[]? -

ageValue integer? -

unit string? -

system uri? -

code code? -

health.fhir.r4: AgeExtension

Closed record

Fields

url uri -

valueAge Age -

health.fhir.r4: AllergyIntolerance

FHIR AllergyIntolerance resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_ALLERGYINTOLERANCE(default RESOURCE_NAME_ALLERGYINTOLERANCE) - The type of the resource describes

meta BaseAllergyIntoleranceMeta(default { profile : [PROFILE_BASE_ALLERGYINTOLERANCE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

note Annotation[]? - Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.

extension Extension[]? - 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.

code CodeableConcept? - Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., 'Latex'), an allergy or intolerance condition (e.g., 'Latex allergy'), or a negated/excluded code for a specific substance or class (e.g., 'No latex allergy') or a general or categorical negated statement (e.g., 'No known allergy', 'No known drug allergies'). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.

onsetRange Range? - Estimated or actual date, date-time, or age when allergy or intolerance was identified.

modifierExtension Extension[]? - 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).

criticality AllergyIntoleranceCriticality? - Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.

language code? - The base language in which the resource is written.

clinicalStatus CodeableConcept? - The clinical status of the allergy or intolerance.

onsetDateTime dateTime? - Estimated or actual date, date-time, or age when allergy or intolerance was identified.

'type AllergyIntoleranceType? - Identification of the underlying physiological mechanism for the reaction risk.

onsetString string? - Estimated or actual date, date-time, or age when allergy or intolerance was identified.

onsetAge Age? - Estimated or actual date, date-time, or age when allergy or intolerance was identified.

lastOccurrence dateTime? - Represents the date and/or time of the last known occurrence of a reaction event.

patient Reference - The patient who has the allergy or intolerance.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

identifier Identifier[]? - Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

recorder Reference? - Individual who recorded the record and takes responsibility for its content.

onsetPeriod Period? - Estimated or actual date, date-time, or age when allergy or intolerance was identified.

reaction AllergyIntoleranceReaction[]? - Details about each adverse reaction event linked to exposure to the identified substance.

verificationStatus CodeableConcept? - Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).

recordedDate dateTime? - The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.

encounter Reference? - The encounter when the allergy or intolerance was asserted.

contained Resource[]? - 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.

asserter Reference? - The source of the information about the allergy that is recorded.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category AllergyIntoleranceCategory[]? - Category of the identified substance.

never... - Rest field

health.fhir.r4: AllergyIntoleranceReaction

Closed record

FHIR AllergyIntoleranceReaction datatype record.

Fields

severity AllergyIntoleranceReactionSeverity? - Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.

note Annotation[]? - Additional text about the adverse reaction event not captured in other fields.

extension Extension[]? - 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.

manifestation CodeableConcept[] - Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.

modifierExtension Extension[]? - 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).

substance CodeableConcept? - Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.

description string? - Text description about the reaction as a whole, including details of the manifestation if required.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

onset dateTime? - Record of the date and/or time of the onset of the Reaction.

exposureRoute CodeableConcept? - Identification of the route by which the subject was exposed to the substance.

health.fhir.r4: Annotation

Closed record

Text node with attribution Elements defined in Ancestors: id, extension

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

authorReference Reference? - Individual responsible for the annotation

authorString string? - Individual responsible for the annotation

time dateTime? - When the annotation was made

text markdown - The annotation - text content (as markdown)

health.fhir.r4: AnnotationExtension

Closed record

Fields

url uri -

valueAnnotation Annotation -

health.fhir.r4: ApiInfo

Closed record

FHIR API information.

Fields

resourceTypereadonly string - FHIR resource type

searchParametersreadonly string[] - supported search parameters

health.fhir.r4: Appointment

FHIR Appointment resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_APPOINTMENT(default RESOURCE_NAME_APPOINTMENT) - The type of the resource describes

meta BaseAppointmentMeta(default { profile : [PROFILE_BASE_APPOINTMENT] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

serviceType CodeableConcept[]? - The specific service that is to be performed during this appointment.

extension Extension[]? - 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.

specialty CodeableConcept[]? - The specialty of a practitioner that would be required to perform the service requested in this appointment.

modifierExtension Extension[]? - 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).

description string? - The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.

reasonReference Reference[]? - Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.

language code? - The base language in which the resource is written.

requestedPeriod Period[]? - A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.

minutesDuration positiveInt? - Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.

slot Reference[]? - The slots from the participants' schedules that will be filled by the appointment.

participant AppointmentParticipant[] - List of participants involved in the appointment.

serviceCategory CodeableConcept[]? - A broad categorization of the service that is to be performed during this appointment.

end instant? - Date/Time that the appointment is to conclude.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

reasonCode CodeableConcept[]? - The coded reason that this appointment is being scheduled. This is more clinical than administrative.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

basedOn Reference[]? - The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).

appointmentType CodeableConcept? - The style of appointment or patient that has been booked in the slot (not service type).

identifier Identifier[]? - This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

created dateTime? - The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.

'start instant? - Date/Time that the appointment is to take place.

supportingInformation Reference[]? - Additional information to support the appointment provided when making the appointment.

priority unsignedInt? - The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).

contained Resource[]? - 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.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

comment string? - Additional comments about the appointment.

cancelationReason CodeableConcept? - The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.

patientInstruction string? - While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).

status AppointmentStatus - The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.

never... - Rest field

health.fhir.r4: AppointmentParticipant

Closed record

FHIR AppointmentParticipant datatype record.

Fields

actor Reference? - A Person, Location/HealthcareService or Device that is participating in the appointment.

extension Extension[]? - 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.

period Period? - Participation period of the actor.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept[]? - Role of participant in the appointment.

required AppointmentParticipantRequired? - Whether this participant is required to be present at the meeting. This covers a use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.

status AppointmentParticipantStatus - Participation status of the actor.

health.fhir.r4: AppointmentResponse

FHIR AppointmentResponse resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_APPOINTMENTRESPONSE(default RESOURCE_NAME_APPOINTMENTRESPONSE) - The type of the resource describes

meta BaseAppointmentResponseMeta(default { profile : [PROFILE_BASE_APPOINTMENTRESPONSE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

identifier Identifier[]? - This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

participantType CodeableConcept[]? - Role of participant in the appointment.

'start instant? - Date/Time that the appointment is to take place, or requested new start time.

appointment Reference - Appointment that this response is replying to.

language code? - The base language in which the resource is written.

actor Reference? - A Person, Location, HealthcareService, or Device that is participating in the appointment.

contained Resource[]? - 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.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

comment string? - Additional comments about the appointment.

end instant? - This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.

participantStatus AppointmentResponseParticipantStatus - Participation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

never... - Rest field

health.fhir.r4: Attachment

Closed record

Content in a format defined elsewhere. Rule: If the Attachment has data, it SHALL have a contentType.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

contentType code? - Mime type of the content, with charset etc. MimeType (Required) (http://hl7.org/fhir/valueset-mimetypes.html)

language code? - Human language of the content (BCP-47) Common Languages (Preferred but limited to AllLanguages) (http://hl7.org/fhir/valueset-languages.html)

data base64Binary? - Data inline, base64ed

url urlType? - Uri where the data can be found

size unsignedInt? - Number of bytes of content (if url provided)

hash base64Binary? - Hash of the data (sha-1, base64ed)

title string? - Label to display in place of the data

creation dateTime? - Date attachment was first created

health.fhir.r4: AttachmentExtension

Closed record

Fields

url uri -

valueAttachment Attachment -

health.fhir.r4: AuditEvent

FHIR AuditEvent resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_AUDITEVENT(default RESOURCE_NAME_AUDITEVENT) - The type of the resource describes

meta BaseAuditEventMeta(default { profile : [PROFILE_BASE_AUDITEVENT] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

agent AuditEventAgent[] - An actor taking an active role in the event or activity that is logged.

extension Extension[]? - 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.

period Period? - The period during which the activity occurred.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

'source AuditEventSource - The system that is reporting the event.

recorded instant - The time when the event was recorded.

'type Coding - Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function.

contained Resource[]? - 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.

subtype Coding[]? - Identifier for the category of event.

outcomeDesc string? - A free text description of the outcome of the event.

action code? - Indicator for type of action performed during the event that generated the audit.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

purposeOfEvent CodeableConcept[]? - The purposeOfUse (reason) that was used during the event being recorded.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

entity AuditEventEntity[]? - Specific instances of data or objects that have been accessed.

outcome code? - Indicates whether the event succeeded or failed.

never... - Rest field

health.fhir.r4: AuditEventAgent

Closed record

FHIR AuditEventAgent datatype record.

Fields

extension Extension[]? - 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.

role CodeableConcept[]? - The security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context.

purposeOfUse CodeableConcept[]? - The reason (purpose of use), specific to this agent, that was used during the event being recorded.

modifierExtension Extension[]? - 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).

media Coding? - Type of media involved. Used when the event is about exporting/importing onto media.

'type CodeableConcept? - Specification of the participation type the user plays when performing the event.

altId string? - Alternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available.

requestor boolean - Indicator that the user is or is not the requestor, or initiator, for the event being audited.

network AuditEventAgentNetwork? - Logical network location for application activity, if the activity has a network location.

name string? - Human-meaningful name for the agent.

location Reference? - Where the event occurred.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

policy uri[]? - The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.

who Reference? - Reference to who this agent is that was involved in the event.

health.fhir.r4: AuditEventAgentNetwork

Closed record

FHIR AuditEventAgentNetwork datatype record.

Fields

extension Extension[]? - 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.

address string? - An identifier for the network access point of the user device for the audit event.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type code? - An identifier for the type of network access point that originated the audit event.

health.fhir.r4: AuditEventEntity

Closed record

FHIR AuditEventEntity datatype record.

Fields

lifecycle Coding? - Identifier for the data life-cycle stage for the entity.

extension Extension[]? - 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.

role Coding? - Code representing the role the entity played in the event being audited.

what Reference? - Identifies a specific instance of the entity. The reference should be version specific.

securityLabel Coding[]? - Security labels for the identified entity.

modifierExtension Extension[]? - 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).

query base64Binary? - The query parameters for a query-type entities.

name string? - A name of the entity in the audit event.

description string? - Text that describes the entity in more detail.

detail AuditEventEntityDetail[]? - Tagged value pairs for conveying additional information about the entity.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type Coding? - The type of the object that was involved in this audit event.

health.fhir.r4: AuditEventEntityDetail

Closed record

FHIR AuditEventEntityDetail datatype record.

Fields

valueBase64Binary base64Binary - The value of the extra detail.

extension Extension[]? - 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.

valueString string - The value of the extra detail.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type string - The type of extra detail provided in the value.

health.fhir.r4: AuditEventSource

Closed record

FHIR AuditEventSource datatype record.

Fields

observer Reference - Identifier of the source where the event was detected.

extension Extension[]? - 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.

site string? - Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type Coding[]? - Code specifying the type of source where event originated.

health.fhir.r4: Availability

Closed record

Fields

availableTime AvailableTime[]? -

notAvailableTime NotAvailableTime[]? -

health.fhir.r4: AvailabilityExtension

Closed record

Fields

url uri -

valueAvailability Availability -

health.fhir.r4: AvailableTime

Closed record

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? -

extension Extension[]? -

daysOfWeek string? -

allDay string? -

availableStartTime string? -

availableEndTime string? -

health.fhir.r4: BackboneElement

Closed record

Base for elements defined inside a resource Elements defined in Ancestors: id, extension.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

modifierExtension Extension[]? - Extensions that cannot be ignored even if unrecognized

health.fhir.r4: Base64BinaryExtension

Closed record

Fields

url uri -

valueBase64Binary base64Binary -

health.fhir.r4: BaseAccountMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Account"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseActivityDefinitionMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/ActivityDefinition"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseAdverseEventMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/AdverseEvent"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseAllergyIntoleranceMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/AllergyIntolerance"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseAppointmentMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Appointment"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseAppointmentResponseMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/AppointmentResponse"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseAuditEventMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/AuditEvent"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseBasicMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Basic"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseBinaryMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Binary"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseBiologicallyDerivedProductMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProduct"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseBodyStructureMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/BodyStructure"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseBundleMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default [PROFILE_BASE_BUNDLE]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseCapabilityStatementMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/CapabilityStatement"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseCarePlanMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/CarePlan"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseCareTeamMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/CareTeam"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseCatalogEntryMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/CatalogEntry"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseChargeItemDefinitionMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/ChargeItemDefinition"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseChargeItemMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/ChargeItem"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseClaimMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Claim"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseClaimResponseMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/ClaimResponse"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseClinicalImpressionMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/ClinicalImpression"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseCodeSystemMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/CodeSystem"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseCommunicationMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Communication"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseCommunicationRequestMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/CommunicationRequest"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseCompartmentDefinitionMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/CompartmentDefinition"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseCompositionMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Composition"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseConceptMapMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/ConceptMap"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseConditionMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Condition"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseConsentMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Consent"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseContractMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Contract"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseCoverageEligibilityRequestMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/CoverageEligibilityRequest"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseCoverageEligibilityResponseMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/CoverageEligibilityResponse"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseCoverageMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Coverage"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseDetectedIssueMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/DetectedIssue"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseDeviceDefinitionMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/DeviceDefinition"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseDeviceMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Device"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseDeviceMetricMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/DeviceMetric"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseDeviceRequestMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/DeviceRequest"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseDeviceUseStatementMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/DeviceUseStatement"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseDiagnosticReportMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/DiagnosticReport"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseDocumentManifestMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/DocumentManifest"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseDocumentReferenceMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseEffectEvidenceSynthesisMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/EffectEvidenceSynthesis"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseEncounterMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Encounter"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseEndpointMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Endpoint"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseEnrollmentRequestMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/EnrollmentRequest"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseEnrollmentResponseMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/EnrollmentResponse"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseEpisodeOfCareMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseEventDefinitionMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/EventDefinition"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseEvidenceMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Evidence"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseEvidenceVariableMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/EvidenceVariable"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseExampleScenarioMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/ExampleScenario"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseExplanationOfBenefitMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseFamilyMemberHistoryMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseFlagMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Flag"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseGoalMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Goal"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseGraphDefinitionMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/GraphDefinition"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseGroupMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Group"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseGuidanceResponseMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/GuidanceResponse"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseHealthcareServiceMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/HealthcareService"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseImagingStudyMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/ImagingStudy"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseImmunizationEvaluationMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/ImmunizationEvaluation"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseImmunizationMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Immunization"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseImmunizationRecommendationMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseImplementationGuideMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/ImplementationGuide"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseInsurancePlanMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/InsurancePlan"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseInvoiceMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Invoice"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseLibraryMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Library"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseLinkageMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Linkage"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseListMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/List"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseLocationMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Location"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseMeasureMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Measure"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseMeasureReportMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/MeasureReport"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseMediaMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Media"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseMedicationAdministrationMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/MedicationAdministration"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseMedicationDispenseMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/MedicationDispense"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseMedicationKnowledgeMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/MedicationKnowledge"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseMedicationMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Medication"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseMedicationRequestMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/MedicationRequest"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseMedicationStatementMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/MedicationStatement"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseMedicinalProductAuthorizationMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/MedicinalProductAuthorization"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseMedicinalProductContraindicationMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/MedicinalProductContraindication"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseMedicinalProductIndicationMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/MedicinalProductIndication"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseMedicinalProductIngredientMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/MedicinalProductIngredient"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseMedicinalProductInteractionMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/MedicinalProductInteraction"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseMedicinalProductManufacturedMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/MedicinalProductManufactured"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseMedicinalProductMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/MedicinalProduct"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseMedicinalProductPackagedMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/MedicinalProductPackaged"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseMedicinalProductPharmaceuticalMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/MedicinalProductPharmaceutical"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseMedicinalProductUndesirableEffectMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/MedicinalProductUndesirableEffect"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseMessageDefinitionMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/MessageDefinition"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseMessageHeaderMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/MessageHeader"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseMolecularSequenceMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/MolecularSequence"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseNamingSystemMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/NamingSystem"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseNutritionOrderMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/NutritionOrder"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: Baseobservation_vitalsignsMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/vitalsigns"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseObservationDefinitionMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseObservationMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Observation"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseOperationDefinitionMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/OperationDefinition"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseOperationOutcomeMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/OperationOutcome"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseOrganizationAffiliationMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/OrganizationAffiliation"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseOrganizationMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Organization"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseParametersMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Parameters"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BasePatientMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Patient"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BasePaymentNoticeMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/PaymentNotice"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BasePaymentReconciliationMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/PaymentReconciliation"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BasePersonMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Person"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BasePlanDefinitionMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/PlanDefinition"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BasePractitionerMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Practitioner"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BasePractitionerRoleMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/PractitionerRole"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseProcedureMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Procedure"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseProvenanceMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Provenance"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseQuestionnaireMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Questionnaire"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseQuestionnaireResponseMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseRelatedPersonMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/RelatedPerson"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseRequestGroupMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/RequestGroup"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseResearchDefinitionMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/ResearchDefinition"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseResearchElementDefinitionMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/ResearchElementDefinition"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseResearchStudyMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/ResearchStudy"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseResearchSubjectMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/ResearchSubject"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseRiskAssessmentMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/RiskAssessment"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseRiskEvidenceSynthesisMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/RiskEvidenceSynthesis"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseScheduleMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Schedule"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseSearchParameterMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/SearchParameter"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseServiceRequestMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/ServiceRequest"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseSlotMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Slot"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseSpecimenDefinitionMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/SpecimenDefinition"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseSpecimenMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Specimen"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseStructureDefinitionMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseStructureMapMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/StructureMap"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseSubscriptionMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Subscription"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseSubstanceMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Substance"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseSubstanceNucleicAcidMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/SubstanceNucleicAcid"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseSubstancePolymerMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/SubstancePolymer"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseSubstanceProteinMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/SubstanceProtein"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseSubstanceReferenceInformationMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/SubstanceReferenceInformation"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseSubstanceSourceMaterialMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/SubstanceSourceMaterial"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseSubstanceSpecificationMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/SubstanceSpecification"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseSupplyDeliveryMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/SupplyDelivery"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseSupplyRequestMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/SupplyRequest"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseTaskMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/Task"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseTerminologyCapabilitiesMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/TerminologyCapabilities"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseTestReportMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/TestReport"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseTestScriptMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/TestScript"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseValueSetMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/ValueSet"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseVerificationResultMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/VerificationResult"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: BaseVisionPrescriptionMeta

Closed record

Fields

Fields Included from *Meta

id string
extension Extension[]
versionId id
lastUpdated instant
source uri
profile canonical[]
security Coding[]
tag Coding[]
Element...

id string? -

extension Extension[]? -

versionId id? -

lastUpdated instant? -

'source uri? -

profile canonical[](default ["http://hl7.org/fhir/StructureDefinition/VisionPrescription"]) -

security Coding[]? -

tag Coding[]? -

health.fhir.r4: Basic

FHIR Basic resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_BASIC(default RESOURCE_NAME_BASIC) - The type of the resource describes

meta BaseBasicMeta(default { profile : [PROFILE_BASE_BASIC] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

identifier Identifier[]? - Identifier assigned to the resource for business purposes, outside the context of FHIR.

extension Extension[]? - 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.

code CodeableConcept - Identifies the 'type' of resource - equivalent to the resource name for other resources.

author Reference? - Indicates who was responsible for creating the resource instance.

created date? - Identifies when the resource was first created.

subject Reference? - Identifies the patient, practitioner, device or any other resource that is the 'focus' of this resource.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

contained Resource[]? - 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.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

never... - Rest field

health.fhir.r4: Binary

FHIR Binary resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_BINARY(default RESOURCE_NAME_BINARY) - The type of the resource describes

meta BaseBinaryMeta(default { profile : [PROFILE_BASE_BINARY] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

data base64Binary? - The actual content, base64 encoded.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

language code? - The base language in which the resource is written.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

securityContext Reference? - This element identifies another resource that can be used as a proxy of the security sensitivity to use when deciding and enforcing access control rules for the Binary resource. Given that the Binary resource contains very few elements that can be used to determine the sensitivity of the data and relationships to individuals, the referenced resource stands in as a proxy equivalent for this purpose. This referenced resource may be related to the Binary (e.g. Media, DocumentReference), or may be some non-related Resource purely as a security proxy. E.g. to identify that the binary resource relates to a patient, and access should only be granted to applications that have access to the patient.

contentType code - MimeType of the binary content represented as a standard MimeType (BCP 13).

never... - Rest field

health.fhir.r4: BiologicallyDerivedProduct

FHIR BiologicallyDerivedProduct resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_BIOLOGICALLYDERIVEDPRODUCT(default RESOURCE_NAME_BIOLOGICALLYDERIVEDPRODUCT) - The type of the resource describes

meta BaseBiologicallyDerivedProductMeta(default { profile : [PROFILE_BASE_BIOLOGICALLYDERIVEDPRODUCT] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

identifier Identifier[]? - This records identifiers associated with this biologically derived product instance that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

parent Reference[]? - Parent product (if any).

request Reference[]? - Procedure request to obtain this biologically derived product.

extension Extension[]? - 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.

quantity integer? - Number of discrete units within this product.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

collection BiologicallyDerivedProductCollection? - How this product was collected.

storage BiologicallyDerivedProductStorage[]? - Product storage.

productCategory BiologicallyDerivedProductProductCategory? - Broad category of this product.

contained Resource[]? - 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.

productCode CodeableConcept? - A code that identifies the kind of this biologically derived product (SNOMED Ctcode).

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

processing BiologicallyDerivedProductProcessing[]? - Any processing of the product during collection that does not change the fundamental nature of the product. For example adding anti-coagulants during the collection of Peripheral Blood Stem Cells.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

manipulation BiologicallyDerivedProductManipulation? - Any manipulation of product post-collection that is intended to alter the product. For example a buffy-coat enrichment or CD8 reduction of Peripheral Blood Stem Cells to make it more suitable for infusion.

status BiologicallyDerivedProductStatus? - Whether the product is currently available.

never... - Rest field

health.fhir.r4: BiologicallyDerivedProductCollection

Closed record

FHIR BiologicallyDerivedProductCollection datatype record.

Fields

extension Extension[]? - 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.

collectedPeriod Period? - Time of product collection.

collectedDateTime dateTime? - Time of product collection.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'source Reference? - The patient or entity, such as a hospital or vendor in the case of a processed/manipulated/manufactured product, providing the product.

collector Reference? - Healthcare professional who is performing the collection.

health.fhir.r4: BiologicallyDerivedProductManipulation

Closed record

FHIR BiologicallyDerivedProductManipulation datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

timePeriod Period? - Time of manipulation.

description string? - Description of manipulation.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

timeDateTime dateTime? - Time of manipulation.

health.fhir.r4: BiologicallyDerivedProductProcessing

Closed record

FHIR BiologicallyDerivedProductProcessing datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

timePeriod Period? - Time of processing.

description string? - Description of of processing.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

procedure CodeableConcept? - Procesing code.

timeDateTime dateTime? - Time of processing.

additive Reference? - Substance added during processing.

health.fhir.r4: BiologicallyDerivedProductStorage

Closed record

FHIR BiologicallyDerivedProductStorage datatype record.

Fields

duration Period? - Storage timeperiod.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

temperature decimal? - Storage temperature.

description string? - Description of storage.

scale BiologicallyDerivedProductStorageScale? - Temperature scale used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: BodyStructure

FHIR BodyStructure resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_BODYSTRUCTURE(default RESOURCE_NAME_BODYSTRUCTURE) - The type of the resource describes

meta BaseBodyStructureMeta(default { profile : [PROFILE_BASE_BODYSTRUCTURE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

identifier Identifier[]? - Identifier for this instance of the anatomical structure.

image Attachment[]? - Image or images used to identify a location.

extension Extension[]? - 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.

morphology CodeableConcept? - The kind of structure being represented by the body structure at BodyStructure.location. This can define both normal and abnormal morphologies.

locationQualifier CodeableConcept[]? - Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.

modifierExtension Extension[]? - 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).

active boolean? - Whether this body site is in active use.

description string? - A summary, characterization or explanation of the body structure.

language code? - The base language in which the resource is written.

contained Resource[]? - 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.

patient Reference - The person to which the body site belongs.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

location CodeableConcept? - The anatomical location or region of the specimen, lesion, or body structure.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

never... - Rest field

health.fhir.r4: BooleanExtension

Closed record

Fields

url uri -

valueBoolean boolean -

health.fhir.r4: Bundle

Closed record

Fields

Fields Included from *Resource

resourceType string
id string
meta Meta
implicitRules uri
language code

resourceType RESOURCE_NAME_BUNDLE(default RESOURCE_NAME_BUNDLE) -

id string? -

meta BaseBundleMeta(default { profile : [PROFILE_BASE_BUNDLE] }) -

implicitRules uri? -

language code? -

identifier Identifier? -

'type BundleType -

timestamp instant? -

total unsignedInt? -

link BundleLink[]? -

entry BundleEntry[]? -

signature Signature? -

health.fhir.r4: BundleEntry

Closed record

Fields

link BundleLink[]? -

fullUrl uri? -

'resource anydata|FHIRWireFormat? -

search BundleEntrySearch? -

request BundleEntryRequest? -

response BundleEntryResponse? -

health.fhir.r4: BundleEntryModel

Closed record

Fields

link BundleLink[]? -

fullUrl uri? -

'resource AnyBaseResource|FHIRWireFormat? -

search BundleEntrySearch? -

request BundleEntryRequest? -

response BundleEntryResponseModel? -

health.fhir.r4: BundleEntryRequest

Closed record

Fields

method HTTPVerb -

url uri -

ifNoneMatch string? -

ifModifiedSince instant? -

ifMatch string? -

ifNoneExist string? -

health.fhir.r4: BundleEntryResponse

Closed record

Fields

status string -

location uri? -

etag string? -

lastModified instant? -

outcome anydata|FHIRWireFormat? -

health.fhir.r4: BundleEntryResponseModel

Closed record

Fields

status string -

location uri? -

etag string? -

lastModified instant? -

outcome AnyBaseResource|FHIRWireFormat? -

health.fhir.r4: BundleEntrySearch

Closed record

Fields

mode SearchEntryMode? -

score decimal? -

health.fhir.r4: BundleLink

Closed record

Fields

relation string -

url uri -

health.fhir.r4: BundleWireModel

Closed record

Fields

Fields Included from *Resource

resourceType string
id string
meta Meta
implicitRules uri
language code

resourceType RESOURCE_NAME_BUNDLE(default RESOURCE_NAME_BUNDLE) -

id string? -

meta BaseBundleMeta(default { profile : [PROFILE_BASE_BUNDLE] }) -

implicitRules uri? -

language code? -

identifier Identifier? -

'type BundleType -

timestamp instant? -

total unsignedInt? -

link BundleLink[]? -

entry BundleEntryModel[]? -

signature Signature? -

health.fhir.r4: CanonicalExtension

Closed record

Fields

url uri -

valueCanonical canonical -

health.fhir.r4: CapabilityStatement

FHIR CapabilityStatement resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_CAPABILITYSTATEMENT(default RESOURCE_NAME_CAPABILITYSTATEMENT) - The type of the resource describes

meta BaseCapabilityStatementMeta(default { profile : [PROFILE_BASE_CAPABILITYSTATEMENT] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime - The date (and optionally time) when the capability statement was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes.

instantiates canonical[]? - Reference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details.

copyright markdown? - A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.

extension Extension[]? - 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.

software CapabilityStatementSoftware? - Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.

purpose markdown? - Explanation of why this capability statement is needed and why it has been designed as it has.

document CapabilityStatementDocument[]? - A document definition.

jurisdiction CodeableConcept[]? - A legal or geographic region in which the capability statement is intended to be used.

modifierExtension Extension[]? - 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).

description markdown? - A free text natural language description of the capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.

experimental boolean? - A Boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language code? - The base language in which the resource is written.

title string? - A short, descriptive, user-friendly title for the capability statement.

contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.

fhirVersion code - The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value.

patchFormat code[]? - A list of the patch formats supported by this implementation using their content types.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

rest CapabilityStatementRest[]? - A definition of the restful capabilities of the solution, if any.

imports canonical[]? - Reference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them.

kind CapabilityStatementKind - The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).

implementation CapabilityStatementImplementation? - Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.

format CapabilityStatementFormat[] - A list of the formats supported by this implementation using their content types.

'version string? - The identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

url uri? - An absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this capability statement is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement is stored on different servers.

messaging CapabilityStatementMessaging[]? - A description of the messaging capabilities of the solution.

implementationGuide canonical[]? - A list of implementation guides that the server does (or should) support in their entirety.

contained Resource[]? - 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.

name string? - A natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher string? - The name of the organization or individual that published the capability statement.

useContext UsageContext[]? - 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 capability statement instances.

status CapabilityStatementStatus - The status of this capability statement. Enables tracking the life-cycle of the content.

never... - Rest field

health.fhir.r4: CapabilityStatementDocument

Closed record

FHIR CapabilityStatementDocument datatype record.

Fields

mode CapabilityStatementDocumentMode - Mode of this document declaration - whether an application is a producer or consumer.

extension Extension[]? - 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.

documentation markdown? - A description of how the application supports or uses the specified document profile. For example, when documents are created, what action is taken with consumed documents, etc.

modifierExtension Extension[]? - 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).

profile canonical - A profile on the document Bundle that constrains which resources are present, and their contents.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: CapabilityStatementImplementation

Closed record

FHIR CapabilityStatementImplementation datatype record.

Fields

extension Extension[]? - 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.

custodian Reference? - The organization responsible for the management of the instance and oversight of the data on the server at the specified URL.

modifierExtension Extension[]? - 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).

description string - Information about the specific installation that this capability statement relates to.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

url urlType? - An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.

health.fhir.r4: CapabilityStatementMessaging

Closed record

FHIR CapabilityStatementMessaging datatype record.

Fields

endpoint CapabilityStatementMessagingEndpoint[]? - An endpoint (network accessible address) to which messages and/or replies are to be sent.

extension Extension[]? - 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.

documentation markdown? - Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, the process for becoming an authorized messaging exchange partner.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

reliableCache unsignedInt? - Length if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender).

supportedMessage CapabilityStatementMessagingSupportedMessage[]? - References to message definitions for messages this system can send or receive.

health.fhir.r4: CapabilityStatementMessagingEndpoint

Closed record

FHIR CapabilityStatementMessagingEndpoint datatype record.

Fields

extension Extension[]? - 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.

protocol Coding - A list of the messaging transport protocol(s) identifiers, supported by this endpoint.

address urlType - The network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifier.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: CapabilityStatementMessagingSupportedMessage

Closed record

FHIR CapabilityStatementMessagingSupportedMessage datatype record.

Fields

mode CapabilityStatementMessagingSupportedMessageMode - The mode of this event declaration - whether application is sender or receiver.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

definition canonical - Points to a message definition that identifies the messaging event, message structure, allowed responses, etc.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: CapabilityStatementRest

Closed record

FHIR CapabilityStatementRest datatype record.

Fields

mode CapabilityStatementRestMode - Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.

extension Extension[]? - 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.

security CapabilityStatementRestSecurity? - Information about security implementation from an interface perspective - what a client needs to know.

'resource CapabilityStatementRestResource[]? - A specification of the restful capabilities of the solution for a specific resource type.

documentation markdown? - Information about the system's restful capabilities that apply across all applications, such as security.

modifierExtension Extension[]? - 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).

compartment canonical[]? - An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL .

interaction CapabilityStatementRestInteraction[]? - A specification of restful operations supported by the system.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: CapabilityStatementRestInteraction

Closed record

FHIR CapabilityStatementRestInteraction datatype record.

Fields

extension Extension[]? - 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.

code CapabilityStatementRestInteractionCode - A coded identifier of the operation, supported by the system.

documentation markdown? - Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: CapabilityStatementRestResource

Closed record

FHIR CapabilityStatementRestResource datatype record.

Fields

updateCreate boolean? - A flag to indicate that the server allows or needs to allow the client to create new identities on the server (that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server.

searchInclude string[]? - A list of _include values supported by the server.

extension Extension[]? - 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.

conditionalCreate boolean? - A flag that indicates that the server supports conditional create.

versioning CapabilityStatementRestResourceVersioning? - This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API.

searchParam CapabilityStatementRestResourceSearchParam[]? - Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.

searchRevInclude string[]? - A list of _revinclude (reverse include) values supported by the server.

documentation markdown? - Additional information about the resource type used by the system.

modifierExtension Extension[]? - 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).

profile canonical? - A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in Using Profiles.

referencePolicy CapabilityStatementRestResourceReferencePolicy[]? - A set of flags that defines how references are supported.

'type code - A type of resource exposed via the restful interface.

supportedProfile canonical[]? - A list of profiles that represent different use cases supported by the system. For a server, 'supported by the system' means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in Using Profiles.

conditionalDelete CapabilityStatementRestResourceConditionalDelete? - A code that indicates how the server supports conditional delete.

conditionalUpdate boolean? - A flag that indicates that the server supports conditional update.

readHistory boolean? - A flag for whether the server is able to return past versions as part of the vRead operation.

conditionalRead CapabilityStatementRestResourceConditionalRead? - A code that indicates how the server supports conditional read.

interaction CapabilityStatementRestResourceInteraction[]? - Identifies a restful operation supported by the solution.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

operation CapabilityStatementRestResourceOperation[]? - Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters.

health.fhir.r4: CapabilityStatementRestResourceInteraction

Closed record

FHIR CapabilityStatementRestResourceInteraction datatype record.

Fields

extension Extension[]? - 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.

code CapabilityStatementRestResourceInteractionCode - Coded identifier of the operation, supported by the system resource.

documentation markdown? - Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: CapabilityStatementRestResourceOperation

Closed record

FHIR CapabilityStatementRestResourceOperation datatype record.

Fields

extension Extension[]? - 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.

documentation markdown? - Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation.

modifierExtension Extension[]? - 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).

name string - The name of the operation or query. For an operation, this is the name prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called.

definition canonical - Where the formal definition can be found. If a server references the base definition of an Operation (i.e. from the specification itself such as http://hl7.org/fhir/OperationDefinition/ValueSet-expand), that means it supports the full capabilities of the operation - e.g. both GET and POST invocation. If it only supports a subset, it must define its own custom OperationDefinition with a 'base' of the original OperationDefinition. The custom definition would describe the specific subset of functionality supported.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: CapabilityStatementRestResourceSearchParam

Closed record

FHIR CapabilityStatementRestResourceSearchParam datatype record.

Fields

extension Extension[]? - 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.

documentation markdown? - This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.

modifierExtension Extension[]? - 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).

name string - The name of the search parameter used in the interface.

definition canonical? - An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to SearchParameter.url). This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CapabilityStatementRestResourceSearchParamType - The type of value a search parameter refers to, and how the content is interpreted.

health.fhir.r4: CapabilityStatementRestSecurity

Closed record

FHIR CapabilityStatementRestSecurity datatype record.

Fields

extension Extension[]? - 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.

cors boolean? - Server adds CORS headers when responding to requests - this enables Javascript applications to use the server.

'service CodeableConcept[]? - Types of security services that are supported/required by the system.

modifierExtension Extension[]? - 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).

description markdown? - General description of how security works.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: CapabilityStatementSoftware

Closed record

FHIR CapabilityStatementSoftware datatype record.

Fields

extension Extension[]? - 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.

releaseDate dateTime? - Date this version of the software was released.

modifierExtension Extension[]? - 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).

name string - Name the software is known by.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version string? - The version identifier for the software covered by this statement.

health.fhir.r4: CarePlan

FHIR CarePlan resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_CAREPLAN(default RESOURCE_NAME_CAREPLAN) - The type of the resource describes

meta BaseCarePlanMeta(default { profile : [PROFILE_BASE_CAREPLAN] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

note Annotation[]? - General notes about the care plan not covered elsewhere.

partOf Reference[]? - A larger care plan of which this particular care plan is a component or step.

addresses Reference[]? - Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.

extension Extension[]? - 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.

activity CarePlanActivity[]? - Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.

subject Reference - Identifies the patient or group whose intended care is described by the plan.

modifierExtension Extension[]? - 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).

description string? - A description of the scope and nature of the plan.

language code? - The base language in which the resource is written.

title string? - Human-friendly name for the care plan.

instantiatesUri uri[]? - The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.

contributor Reference[]? - Identifies the individual(s) or organization who provided the contents of the care plan.

supportingInfo Reference[]? - Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

basedOn Reference[]? - A care plan that is fulfilled in whole or in part by this care plan.

careTeam Reference[]? - Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.

identifier Identifier[]? - Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

period Period? - Indicates when the plan did (or is intended to) come into effect and end.

goal Reference[]? - Describes the intended objective(s) of carrying out the care plan.

author Reference? - When populated, the author is responsible for the care plan. The care plan is attributed to the author.

created dateTime? - Represents when this particular CarePlan record was created in the system, which is often a system-generated date.

replaces Reference[]? - Completed or terminated care plan whose function is taken by this new care plan.

encounter Reference? - The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.

instantiatesCanonical canonical[]? - The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.

intent CarePlanIntent - Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.

contained Resource[]? - 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.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[]? - Identifies what 'kind' of plan this is to support differentiation between multiple co-existing plans; e.g. 'Home health', 'psychiatric', 'asthma', 'disease management', 'wellness plan', etc.

status CarePlanStatus - Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

never... - Rest field

health.fhir.r4: CarePlanActivity

Closed record

FHIR CarePlanActivity datatype record.

Fields

reference Reference? - The details of the proposed activity represented in a specific resource.

extension Extension[]? - 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.

outcomeCodeableConcept CodeableConcept[]? - Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).

outcomeReference Reference[]? - Details of the outcome or action resulting from the activity. The reference to an 'event' resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource).

modifierExtension Extension[]? - 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).

progress Annotation[]? - Notes about the adherence/status/progress of the activity.

detail CarePlanActivityDetail? - A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: CarePlanActivityDetail

Closed record

FHIR CarePlanActivityDetail datatype record.

Fields

extension Extension[]? - 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.

code CodeableConcept? - Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter.

goal Reference[]? - Internal reference that identifies the goals that this activity is intended to contribute towards meeting.

performer Reference[]? - Identifies who's expected to be involved in the activity.

quantity Quantity? - Identifies the quantity expected to be supplied, administered or consumed by the subject.

kind CarePlanActivityDetailKind? - A description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.

modifierExtension Extension[]? - 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).

description string? - This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.

productReference Reference? - Identifies the food, drug or other product to be consumed or supplied in the activity.

reasonReference Reference[]? - Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan.

instantiatesCanonical canonical[]? - The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.

instantiatesUri uri[]? - The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.

scheduledString string? - The period, timing or frequency upon which the described activity is to occur.

statusReason CodeableConcept? - Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.

scheduledTiming Timing? - The period, timing or frequency upon which the described activity is to occur.

scheduledPeriod Period? - The period, timing or frequency upon which the described activity is to occur.

dailyAmount Quantity? - Identifies the quantity expected to be consumed in a given day.

location Reference? - Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

reasonCode CodeableConcept[]? - Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.

doNotPerform boolean? - If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan.

productCodeableConcept CodeableConcept? - Identifies the food, drug or other product to be consumed or supplied in the activity.

status CarePlanActivityDetailStatus - Identifies what progress is being made for the specific activity.

health.fhir.r4: CareTeam

FHIR CareTeam resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_CARETEAM(default RESOURCE_NAME_CARETEAM) - The type of the resource describes

meta BaseCareTeamMeta(default { profile : [PROFILE_BASE_CARETEAM] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

identifier Identifier[]? - Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

note Annotation[]? - Comments made about the CareTeam.

extension Extension[]? - 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.

period Period? - Indicates when the team did (or is intended to) come into effect and end.

subject Reference? - Identifies the patient or group whose intended care is handled by the team.

modifierExtension Extension[]? - 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).

reasonReference Reference[]? - Condition(s) that this care team addresses.

language code? - The base language in which the resource is written.

encounter Reference? - The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.

participant CareTeamParticipant[]? - Identifies all people and organizations who are expected to be involved in the care team.

contained Resource[]? - 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.

managingOrganization Reference[]? - The organization responsible for the care team.

name string? - A label for human use intended to distinguish like teams. E.g. the 'red' vs. 'green' trauma teams.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

telecom ContactPoint[]? - A central contact detail for the care team (that applies to all members).

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

reasonCode CodeableConcept[]? - Describes why the care team exists.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

category CodeableConcept[]? - Identifies what kind of team. This is to support differentiation between multiple co-existing teams, such as care plan team, episode of care team, longitudinal care team.

status CareTeamStatus? - Indicates the current state of the care team.

never... - Rest field

health.fhir.r4: CareTeamParticipant

Closed record

FHIR CareTeamParticipant datatype record.

Fields

extension Extension[]? - 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.

period Period? - Indicates when the specific member or organization did (or is intended to) come into effect and end.

role CodeableConcept[]? - Indicates specific responsibility of an individual within the care team, such as 'Primary care physician', 'Trained social worker counselor', 'Caregiver', etc.

modifierExtension Extension[]? - 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).

member Reference? - The specific person or organization who is participating/expected to participate in the care team.

onBehalfOf Reference? - The organization of the practitioner.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: CatalogEntry

FHIR CatalogEntry resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_CATALOGENTRY(default RESOURCE_NAME_CATALOGENTRY) - The type of the resource describes

meta BaseCatalogEntryMeta(default { profile : [PROFILE_BASE_CATALOGENTRY] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

additionalClassification CodeableConcept[]? - User for example for ATC classification, or.

identifier Identifier[]? - Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code.

extension Extension[]? - 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.

relatedEntry CatalogEntryRelatedEntry[]? - Used for example, to point to a substance, or to a device used to administer a medication.

orderable boolean - Whether the entry represents an orderable item.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

additionalIdentifier Identifier[]? - Used in supporting related concepts, e.g. NDC to RxNorm.

classification CodeableConcept[]? - Classes of devices, or ATC for medication.

'type CodeableConcept? - The type of item - medication, device, service, protocol or other.

validityPeriod Period? - The time period in which this catalog entry is expected to be active.

lastUpdated dateTime? - Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.

contained Resource[]? - 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.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

additionalCharacteristic CodeableConcept[]? - Used for examplefor Out of Formulary, or any specifics.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

referencedItem Reference - The item in a catalog or definition.

status CatalogEntryStatus? - Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.

validTo dateTime? - The date until which this catalog entry is expected to be active.

never... - Rest field

health.fhir.r4: CatalogEntryRelatedEntry

Closed record

FHIR CatalogEntryRelatedEntry datatype record.

Fields

extension Extension[]? - 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.

item Reference - The reference to the related item.

relationtype CatalogEntryRelatedEntryRelationtype - The type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etc.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ChargeItem

FHIR ChargeItem resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_CHARGEITEM(default RESOURCE_NAME_CHARGEITEM) - The type of the resource describes

meta BaseChargeItemMeta(default { profile : [PROFILE_BASE_CHARGEITEM] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

note Annotation[]? - Comments made about the event by the performer, subject or other participants.

partOf Reference[]? - ChargeItems can be grouped to larger ChargeItems covering the whole set.

reason CodeableConcept[]? - Describes why the event occurred in coded or textual form.

definitionCanonical canonical[]? - References the source of pricing information, rules of application for the code this ChargeItem uses.

extension Extension[]? - 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.

code CodeableConcept - A code that identifies the charge, like a billing code.

subject Reference - The individual or set of individuals the action is being or was performed on.

modifierExtension Extension[]? - 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).

overrideReason string? - If the list price or the rule-based factor associated with the code is overridden, this attribute can capture a text to indicate the reason for this action.

productReference Reference? - Identifies the device, food, drug or other product being charged either by type code or reference to an instance.

language code? - The base language in which the resource is written.

definitionUri uri[]? - References the (external) source of pricing information, rules of application for the code this ChargeItem uses.

performingOrganization Reference? - The organization requesting the service.

context Reference? - The encounter or episode of care that establishes the context for this event.

enterer Reference? - The device, practitioner, etc. who entered the charge item.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

factorOverride decimal? - Factor overriding the factor determined by the rules associated with the code.

identifier Identifier[]? - Identifiers assigned to this event performer or other systems.

bodysite CodeableConcept[]? - The anatomical location where the related service has been applied.

performer ChargeItemPerformer[]? - Indicates who or what performed or participated in the charged service.

quantity Quantity? - Quantity of which the charge item has been serviced.

costCenter Reference? - The financial cost center permits the tracking of charge attribution.

enteredDate dateTime? - Date the charge item was entered.

priceOverride Money? - Total price of the charge overriding the list price associated with the code.

supportingInformation Reference[]? - Further information supporting this charge.

occurrenceTiming Timing? - Date/time(s) or duration when the charged service was applied.

contained Resource[]? - 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.

occurrencePeriod Period? - Date/time(s) or duration when the charged service was applied.

'service Reference[]? - Indicated the rendered service that caused this charge.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

occurrenceDateTime dateTime? - Date/time(s) or duration when the charged service was applied.

requestingOrganization Reference? - The organization performing the service.

account Reference[]? - Account into which this ChargeItems belongs.

productCodeableConcept CodeableConcept? - Identifies the device, food, drug or other product being charged either by type code or reference to an instance.

status ChargeItemStatus - The current state of the ChargeItem.

never... - Rest field

health.fhir.r4: ChargeItemDefinition

FHIR ChargeItemDefinition resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_CHARGEITEMDEFINITION(default RESOURCE_NAME_CHARGEITEMDEFINITION) - The type of the resource describes

meta BaseChargeItemDefinitionMeta(default { profile : [PROFILE_BASE_CHARGEITEMDEFINITION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime? - The date (and optionally time) when the charge item definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the charge item definition changes.

propertyGroup ChargeItemDefinitionPropertyGroup[]? - Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.

partOf canonical[]? - A larger definition of which this particular definition is a component or step.

copyright markdown? - A copyright statement relating to the charge item definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the charge item definition.

extension Extension[]? - 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.

approvalDate date? - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

code CodeableConcept? - The defined billing details in this resource pertain to the given billing code.

instance Reference[]? - The defined billing details in this resource pertain to the given product instance(s).

jurisdiction CodeableConcept[]? - A legal or geographic region in which the charge item definition is intended to be used.

modifierExtension Extension[]? - 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).

description markdown? - A free text natural language description of the charge item definition from a consumer's perspective.

experimental boolean? - A Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language code? - The base language in which the resource is written.

title string? - A short, descriptive, user-friendly title for the charge item definition.

contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

derivedFromUri uri[]? - The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.

identifier Identifier[]? - A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

effectivePeriod Period? - The period during which the charge item definition content was or is planned to be in active use.

replaces canonical[]? - As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.

'version string? - The identifier that is used to identify this version of the charge item definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the charge item definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.

url uri - An absolute URI that is used to identify this charge item definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this charge item definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the charge item definition is stored on different servers.

contained Resource[]? - 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.

lastReviewDate date? - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher string? - The name of the organization or individual that published the charge item definition.

applicability ChargeItemDefinitionApplicability[]? - Expressions that describe applicability criteria for the billing code.

useContext UsageContext[]? - 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 charge item definition instances.

status ChargeItemDefinitionStatus - The current state of the ChargeItemDefinition.

never... - Rest field

health.fhir.r4: ChargeItemDefinitionApplicability

Closed record

FHIR ChargeItemDefinitionApplicability datatype record.

Fields

extension Extension[]? - 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.

expression string? - An expression that returns true or false, indicating whether the condition is satisfied. When using FHIRPath expressions, the %context environment variable must be replaced at runtime with the ChargeItem resource to which this definition is applied.

modifierExtension Extension[]? - 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).

description string? - A brief, natural language description of the condition that effectively communicates the intended semantics.

language string? - The media type of the language for the expression, e.g. 'text/cql' for Clinical Query Language expressions or 'text/fhirpath' for FHIRPath expressions.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ChargeItemDefinitionPropertyGroup

Closed record

FHIR ChargeItemDefinitionPropertyGroup datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

priceComponent ChargeItemDefinitionPropertyGroupPriceComponent[]? - The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the prices have been calculated.

health.fhir.r4: ChargeItemDefinitionPropertyGroupPriceComponent

Closed record

FHIR ChargeItemDefinitionPropertyGroupPriceComponent datatype record.

Fields

amount Money? - The amount calculated for this component.

extension Extension[]? - 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.

code CodeableConcept? - A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

factor decimal? - The factor that has been applied on the base price for calculating this component.

'type ChargeItemDefinitionPropertyGroupPriceComponentType - This code identifies the type of the component.

health.fhir.r4: ChargeItemPerformer

Closed record

FHIR ChargeItemPerformer datatype record.

Fields

actor Reference - The device, practitioner, etc. who performed or participated in the service.

extension Extension[]? - 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.

'function CodeableConcept? - Describes the type of performance or participation(e.g. primary surgeon, anesthesiologiest, etc.).

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: Claim

FHIR Claim resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_CLAIM(default RESOURCE_NAME_CLAIM) - The type of the resource describes

meta BaseClaimMeta(default { profile : [PROFILE_BASE_CLAIM] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

insurance ClaimInsurance[] - Financial instruments for reimbursement for the health care products and services specified on the claim.

extension Extension[]? - 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.

use ClaimUse - A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

'type CodeableConcept - The category of claim, e.g. oral, pharmacy, vision, institutional, professional.

accident ClaimAccident? - Details of an accident which resulted in injuries which required the products and services listed in the claim.

payee ClaimPayee? - The party to be reimbursed for cost of the products and services according to the terms of the policy.

total Money? - The total value of the all the items in the claim.

supportingInfo ClaimSupportingInfo[]? - Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.

fundsReserve CodeableConcept? - A code to indicate whether and for whom funds are to be reserved for future claims.

provider Reference - The provider which is responsible for the claim, predetermination or preauthorization.

insurer Reference? - The Insurer who is target of the request.

patient Reference - The party to whom the professional services and/or products have been supplied or are being considered and for whom actual or forecast reimbursement is sought.

enterer Reference? - Individual who created the claim, predetermination or preauthorization.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

careTeam ClaimCareTeam[]? - The members of the team who provided the products and services.

identifier Identifier[]? - A unique identifier assigned to this claim.

item ClaimItem[]? - A claim line. Either a simple product or service or a 'group' of details which can each be a simple items or groups of sub-details.

created dateTime - The date this resource was created.

diagnosis ClaimDiagnosis[]? - Information about diagnoses relevant to the claim items.

originalPrescription Reference? - Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.

procedure ClaimProcedure[]? - Procedures performed on the patient relevant to the billing items with the claim.

priority CodeableConcept - The provider-required urgency of processing the request. Typical values include: stat, routine deferred.

contained Resource[]? - 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.

referral Reference? - A reference to a referral resource.

prescription Reference? - Prescription to support the dispensing of pharmacy, device or vision products.

billablePeriod Period? - The period for which charges are being submitted.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

subType CodeableConcept? - A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

facility Reference? - Facility where the services were provided.

status ClaimStatus - The status of the resource instance.

never... - Rest field

health.fhir.r4: ClaimAccident

Closed record

FHIR ClaimAccident datatype record.

Fields

date date - Date of an accident event related to the products and services contained in the claim.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

locationAddress Address? - The physical location of the accident event.

locationReference Reference? - The physical location of the accident event.

'type CodeableConcept? - The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers.

health.fhir.r4: ClaimCareTeam

Closed record

FHIR ClaimCareTeam datatype record.

Fields

qualification CodeableConcept? - The qualification of the practitioner which is applicable for this service.

sequence positiveInt - A number to uniquely identify care team entries.

extension Extension[]? - 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.

role CodeableConcept? - The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team.

provider Reference - Member of the team who provided the product or service.

modifierExtension Extension[]? - 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).

responsible boolean? - The party who is billing and/or responsible for the claimed products or services.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ClaimDiagnosis

Closed record

FHIR ClaimDiagnosis datatype record.

Fields

sequence positiveInt - A number to uniquely identify diagnosis entries.

extension Extension[]? - 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.

onAdmission CodeableConcept? - Indication of whether the diagnosis was present on admission to a facility.

packageCode CodeableConcept? - A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept[]? - When the condition was observed or the relative ranking.

diagnosisReference Reference - The nature of illness or problem in a coded form or as a reference to an external defined Condition.

diagnosisCodeableConcept CodeableConcept - The nature of illness or problem in a coded form or as a reference to an external defined Condition.

health.fhir.r4: ClaimInsurance

Closed record

FHIR ClaimInsurance datatype record.

Fields

coverage Reference - Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.

identifier Identifier? - The business identifier to be used when the claim is sent for adjudication against this insurance policy.

sequence positiveInt - A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.

extension Extension[]? - 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.

businessArrangement string? - A business agreement number established between the provider and the insurer for special business processing purposes.

claimResponse Reference? - The result of the adjudication of the line items for the Coverage specified in this insurance.

focal boolean - A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.

modifierExtension Extension[]? - 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).

preAuthRef string[]? - Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ClaimItem

Closed record

FHIR ClaimItem datatype record.

Fields

extension Extension[]? - 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.

modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension Extension[]? - 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).

locationAddress Address? - Where the product or service was provided.

productOrService CodeableConcept - When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

servicedPeriod Period? - The date or dates when the service or product was supplied, performed or completed.

informationSequence positiveInt[]? - Exceptions, special conditions and supporting information applicable for this service or product.

revenue CodeableConcept? - The type of revenue or cost center providing the product and/or service.

locationCodeableConcept CodeableConcept? - Where the product or service was provided.

diagnosisSequence positiveInt[]? - Diagnosis applicable for this service or product.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

locationReference Reference? - Where the product or service was provided.

factor decimal? - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net Money? - The quantity times the unit price for an additional service or product or charge.

unitPrice Money? - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

quantity Quantity? - The number of repetitions of a service or product.

programCode CodeableConcept[]? - Identifies the program under which this may be recovered.

careTeamSequence positiveInt[]? - CareTeam members related to this service or product.

encounter Reference[]? - The Encounters during which this Claim was created or to which the creation of this record is tightly associated.

sequence positiveInt - A number to uniquely identify item entries.

bodySite CodeableConcept? - Physical service site on the patient (limb, tooth, etc.).

subSite CodeableConcept[]? - A region or surface of the bodySite, e.g. limb region or tooth surface(s).

detail ClaimItemDetail[]? - A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

servicedDate date? - The date or dates when the service or product was supplied, performed or completed.

udi Reference[]? - Unique Device Identifiers associated with this line item.

category CodeableConcept? - Code to identify the general type of benefits under which products and services are provided.

procedureSequence positiveInt[]? - Procedures applicable for this service or product.

health.fhir.r4: ClaimItemDetail

Closed record

FHIR ClaimItemDetail datatype record.

Fields

unitPrice Money? - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

extension Extension[]? - 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.

quantity Quantity? - The number of repetitions of a service or product.

programCode CodeableConcept[]? - Identifies the program under which this may be recovered.

modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension Extension[]? - 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).

subDetail ClaimItemDetailSubDetail[]? - A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

productOrService CodeableConcept - When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

sequence positiveInt - A number to uniquely identify item entries.

revenue CodeableConcept? - The type of revenue or cost center providing the product and/or service.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

udi Reference[]? - Unique Device Identifiers associated with this line item.

category CodeableConcept? - Code to identify the general type of benefits under which products and services are provided.

factor decimal? - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net Money? - The quantity times the unit price for an additional service or product or charge.

health.fhir.r4: ClaimItemDetailSubDetail

Closed record

FHIR ClaimItemDetailSubDetail datatype record.

Fields

unitPrice Money? - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

extension Extension[]? - 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.

quantity Quantity? - The number of repetitions of a service or product.

programCode CodeableConcept[]? - Identifies the program under which this may be recovered.

modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension Extension[]? - 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).

productOrService CodeableConcept - When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

sequence positiveInt - A number to uniquely identify item entries.

revenue CodeableConcept? - The type of revenue or cost center providing the product and/or service.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

udi Reference[]? - Unique Device Identifiers associated with this line item.

category CodeableConcept? - Code to identify the general type of benefits under which products and services are provided.

factor decimal? - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net Money? - The quantity times the unit price for an additional service or product or charge.

health.fhir.r4: ClaimPayee

Closed record

FHIR ClaimPayee datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - Type of Party to be reimbursed: subscriber, provider, other.

party Reference? - Reference to the individual or organization to whom any payment will be made.

health.fhir.r4: ClaimProcedure

Closed record

FHIR ClaimProcedure datatype record.

Fields

date dateTime? - Date and optionally time the procedure was performed.

sequence positiveInt - A number to uniquely identify procedure entries.

extension Extension[]? - 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.

procedureCodeableConcept CodeableConcept - The code or reference to a Procedure resource which identifies the clinical intervention performed.

modifierExtension Extension[]? - 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).

procedureReference Reference - The code or reference to a Procedure resource which identifies the clinical intervention performed.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

udi Reference[]? - Unique Device Identifiers associated with this line item.

'type CodeableConcept[]? - When the condition was observed or the relative ranking.

health.fhir.r4: ClaimRelated

Closed record

FHIR ClaimRelated datatype record.

Fields

reference Identifier? - An alternate organizational reference to the case or file to which this particular claim pertains.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

claim Reference? - Reference to a related claim.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

relationship CodeableConcept? - A code to convey how the claims are related.

health.fhir.r4: ClaimResponse

FHIR ClaimResponse resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_CLAIMRESPONSE(default RESOURCE_NAME_CLAIMRESPONSE) - The type of the resource describes

meta BaseClaimResponseMeta(default { profile : [PROFILE_BASE_CLAIMRESPONSE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

insurance ClaimResponseInsurance[]? - Financial instruments for reimbursement for the health care products and services specified on the claim.

request Reference? - Original request resource reference.

extension Extension[]? - 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.

use ClaimResponseUse - A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.

modifierExtension Extension[]? - 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).

payeeType CodeableConcept? - Type of Party to be reimbursed: subscriber, provider, other.

preAuthRef string? - Reference from the Insurer which is used in later communications which refers to this adjudication.

language code? - The base language in which the resource is written.

'error ClaimResponseError[]? - Errors encountered during the processing of the adjudication.

'type CodeableConcept - A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

processNote ClaimResponseProcessNote[]? - A note that describes or explains adjudication results in a human readable form.

addItem ClaimResponseAddItem[]? - The first-tier service adjudications for payor added product or service lines.

total ClaimResponseTotal[]? - Categorized monetary totals for the adjudication.

fundsReserve CodeableConcept? - A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.

insurer Reference - The party responsible for authorization, adjudication and reimbursement.

patient Reference - The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought.

communicationRequest Reference[]? - Request for additional supporting or authorizing information.

payment ClaimResponsePayment? - Payment details for the adjudication of the claim.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

outcome ClaimResponseOutcome - The outcome of the claim, predetermination, or preauthorization processing.

identifier Identifier[]? - A unique identifier assigned to this claim response.

item ClaimResponseItem[]? - A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.

preAuthPeriod Period? - The time frame during which this authorization is effective.

formCode CodeableConcept? - A code for the form to be used for printing the content.

created dateTime - The date this resource was created.

requestor Reference? - The provider which is responsible for the claim, predetermination or preauthorization.

contained Resource[]? - 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.

disposition string? - A human readable description of the status of the adjudication.

form Attachment? - The actual form, by reference or inclusion, for printing the content or an EOB.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

subType CodeableConcept? - A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

status ClaimResponseStatus - The status of the resource instance.

never... - Rest field

health.fhir.r4: ClaimResponseAddItem

Closed record

FHIR ClaimResponseAddItem datatype record.

Fields

unitPrice Money? - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

extension Extension[]? - 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.

quantity Quantity? - The number of repetitions of a service or product.

programCode CodeableConcept[]? - Identifies the program under which this may be recovered.

modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension Extension[]? - 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).

subdetailSequence positiveInt[]? - The sequence number of the sub-details within the details within the claim item which this line is intended to replace.

locationAddress Address? - Where the product or service was provided.

productOrService CodeableConcept - When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

noteNumber positiveInt[]? - The numbers associated with notes below which apply to the adjudication of this item.

servicedPeriod Period? - The date or dates when the service or product was supplied, performed or completed.

itemSequence positiveInt[]? - Claim items which this service line is intended to replace.

bodySite CodeableConcept? - Physical service site on the patient (limb, tooth, etc.).

locationCodeableConcept CodeableConcept? - Where the product or service was provided.

provider Reference[]? - The providers who are authorized for the services rendered to the patient.

detailSequence positiveInt[]? - The sequence number of the details within the claim item which this line is intended to replace.

subSite CodeableConcept[]? - A region or surface of the bodySite, e.g. limb region or tooth surface(s).

detail ClaimResponseAddItemDetail[]? - The second-tier service adjudications for payor added services.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

locationReference Reference? - Where the product or service was provided.

servicedDate date? - The date or dates when the service or product was supplied, performed or completed.

factor decimal? - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net Money? - The quantity times the unit price for an additional service or product or charge.

health.fhir.r4: ClaimResponseAddItemDetail

Closed record

FHIR ClaimResponseAddItemDetail datatype record.

Fields

unitPrice Money? - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

extension Extension[]? - 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.

quantity Quantity? - The number of repetitions of a service or product.

modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension Extension[]? - 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).

subDetail ClaimResponseAddItemDetailSubDetail[]? - The third-tier service adjudications for payor added services.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

productOrService CodeableConcept - When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

factor decimal? - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net Money? - The quantity times the unit price for an additional service or product or charge.

noteNumber positiveInt[]? - The numbers associated with notes below which apply to the adjudication of this item.

health.fhir.r4: ClaimResponseAddItemDetailSubDetail

Closed record

FHIR ClaimResponseAddItemDetailSubDetail datatype record.

Fields

unitPrice Money? - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

extension Extension[]? - 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.

quantity Quantity? - The number of repetitions of a service or product.

modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

productOrService CodeableConcept - When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

factor decimal? - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net Money? - The quantity times the unit price for an additional service or product or charge.

noteNumber positiveInt[]? - The numbers associated with notes below which apply to the adjudication of this item.

health.fhir.r4: ClaimResponseError

Closed record

FHIR ClaimResponseError datatype record.

Fields

subDetailSequence positiveInt? - The sequence number of the sub-detail within the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.

itemSequence positiveInt? - The sequence number of the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.

extension Extension[]? - 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.

code CodeableConcept - An error code, from a specified code system, which details why the claim could not be adjudicated.

detailSequence positiveInt? - The sequence number of the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ClaimResponseInsurance

Closed record

FHIR ClaimResponseInsurance datatype record.

Fields

coverage Reference - Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.

sequence positiveInt - A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.

extension Extension[]? - 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.

businessArrangement string? - A business agreement number established between the provider and the insurer for special business processing purposes.

claimResponse Reference? - The result of the adjudication of the line items for the Coverage specified in this insurance.

focal boolean - A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ClaimResponseItem

Closed record

FHIR ClaimResponseItem datatype record.

Fields

adjudication ClaimResponseItemAdjudication[] - If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.

itemSequence positiveInt - A number to uniquely reference the claim item entries.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

detail ClaimResponseItemDetail[]? - A claim detail. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

noteNumber positiveInt[]? - The numbers associated with notes below which apply to the adjudication of this item.

health.fhir.r4: ClaimResponseItemAdjudication

Closed record

FHIR ClaimResponseItemAdjudication datatype record.

Fields

reason CodeableConcept? - A code supporting the understanding of the adjudication result and explaining variance from expected amount.

amount Money? - Monetary amount associated with the category.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category CodeableConcept - A code to indicate the information type of this adjudication record. Information types may include the value submitted, maximum values or percentages allowed or payable under the plan, amounts that: the patient is responsible for in aggregate or pertaining to this item; amounts paid by other coverages; and, the benefit payable for this item.

value decimal? - A non-monetary value associated with the category. Mutually exclusive to the amount element above.

health.fhir.r4: ClaimResponseItemDetail

Closed record

FHIR ClaimResponseItemDetail datatype record.

Fields

extension Extension[]? - 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.

detailSequence positiveInt - A number to uniquely reference the claim detail entry.

modifierExtension Extension[]? - 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).

subDetail ClaimResponseItemDetailSubDetail[]? - A sub-detail adjudication of a simple product or service.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

noteNumber positiveInt[]? - The numbers associated with notes below which apply to the adjudication of this item.

health.fhir.r4: ClaimResponseItemDetailSubDetail

Closed record

FHIR ClaimResponseItemDetailSubDetail datatype record.

Fields

subDetailSequence positiveInt - A number to uniquely reference the claim sub-detail entry.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

noteNumber positiveInt[]? - The numbers associated with notes below which apply to the adjudication of this item.

health.fhir.r4: ClaimResponsePayment

Closed record

FHIR ClaimResponsePayment datatype record.

Fields

date date? - Estimated date the payment will be issued or the actual issue date of payment.

identifier Identifier? - Issuer's unique identifier for the payment instrument.

adjustmentReason CodeableConcept? - Reason for the payment adjustment.

amount Money - Benefits payable less any payment adjustment.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

adjustment Money? - Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - Whether this represents partial or complete payment of the benefits payable.

health.fhir.r4: ClaimResponseProcessNote

Closed record

FHIR ClaimResponseProcessNote datatype record.

Fields

number positiveInt? - A number to uniquely identify a note entry.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

language CodeableConcept? - A code to define the language used in the text of the note.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string - The explanation or description associated with the processing.

'type ClaimResponseProcessNoteType? - The business purpose of the note text.

health.fhir.r4: ClaimResponseTotal

Closed record

FHIR ClaimResponseTotal datatype record.

Fields

amount Money - Monetary total amount associated with the category.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category CodeableConcept - A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

health.fhir.r4: ClaimSupportingInfo

Closed record

FHIR ClaimSupportingInfo datatype record.

Fields

valueBoolean boolean? - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

reason CodeableConcept? - Provides the reason in the situation where a reason code is required in addition to the content.

extension Extension[]? - 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.

code CodeableConcept? - System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.

valueReference Reference? - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

timingPeriod Period? - The date when or period to which this information refers.

modifierExtension Extension[]? - 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).

timingDate date? - The date when or period to which this information refers.

sequence positiveInt - A number to uniquely identify supporting information entries.

valueAttachment Attachment? - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

valueString string? - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category CodeableConcept - The general class of the information supplied: information; exception; accident, employment; onset, etc.

valueQuantity Quantity? - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

health.fhir.r4: ClinicalImpression

FHIR ClinicalImpression resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_CLINICALIMPRESSION(default RESOURCE_NAME_CLINICALIMPRESSION) - The type of the resource describes

meta BaseClinicalImpressionMeta(default { profile : [PROFILE_BASE_CLINICALIMPRESSION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime? - Indicates when the documentation of the assessment was complete.

note Annotation[]? - Commentary about the impression, typically recorded after the impression itself was made, though supplemental notes by the original author could also appear.

extension Extension[]? - 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.

code CodeableConcept? - Categorizes the type of clinical assessment performed.

assessor Reference? - The clinician performing the assessment.

subject Reference - The patient or group of individuals assessed as part of this record.

modifierExtension Extension[]? - 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).

description string? - A summary of the context and/or cause of the assessment - why / where it was performed, and what patient events/status prompted it.

prognosisReference Reference[]? - RiskAssessment expressing likely outcome.

language code? - The base language in which the resource is written.

protocol uri[]? - Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis.

problem Reference[]? - A list of the relevant problems/conditions for a patient.

statusReason CodeableConcept? - Captures the reason for the current state of the ClinicalImpression.

supportingInfo Reference[]? - Information supporting the clinical impression.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

summary string? - A text summary of the investigations and the diagnosis.

identifier Identifier[]? - Business identifiers assigned to this clinical impression by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

effectivePeriod Period? - The point in time or period over which the subject was assessed.

previous Reference? - A reference to the last assessment that was conducted on this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient's conditions changes.

encounter Reference? - The Encounter during which this ClinicalImpression was created or to which the creation of this record is tightly associated.

finding ClinicalImpressionFinding[]? - Specific findings or diagnoses that were considered likely or relevant to ongoing treatment.

prognosisCodeableConcept CodeableConcept[]? - Estimate of likely outcome.

contained Resource[]? - 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.

effectiveDateTime dateTime? - The point in time or period over which the subject was assessed.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

investigation ClinicalImpressionInvestigation[]? - One or more sets of investigations (signs, symptoms, etc.). The actual grouping of investigations varies greatly depending on the type and context of the assessment. These investigations may include data generated during the assessment process, or data previously generated and recorded that is pertinent to the outcomes.

status ClinicalImpressionStatus - Identifies the workflow status of the assessment.

never... - Rest field

health.fhir.r4: ClinicalImpressionFinding

Closed record

FHIR ClinicalImpressionFinding datatype record.

Fields

itemReference Reference? - Specific reference for finding or diagnosis, which may include ruled-out or resolved conditions.

extension Extension[]? - 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.

itemCodeableConcept CodeableConcept? - Specific text or code for finding or diagnosis, which may include ruled-out or resolved conditions.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

basis string? - Which investigations support finding or diagnosis.

health.fhir.r4: ClinicalImpressionInvestigation

Closed record

FHIR ClinicalImpressionInvestigation datatype record.

Fields

extension Extension[]? - 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.

item Reference[]? - A record of a specific investigation that was undertaken.

code CodeableConcept - A name/code for the group ('set') of investigations. Typically, this will be something like 'signs', 'symptoms', 'clinical', 'diagnostic', but the list is not constrained, and others such groups such as (exposure|family|travel|nutritional) history may be used.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: CodeableConcept

Closed record

A CodeableConcept represents a value that is usually supplied by providing a reference to one or more terminologies or ontologies but may also be defined by the provision of text.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

coding Coding[]? - Code defined by a terminology system

text string? - Plain text representation of the concept

health.fhir.r4: CodeableConceptExtension

Closed record

Fields

url uri -

valueCodeableConcept CodeableConcept -

health.fhir.r4: CodeableReference

Closed record

Reference to a resource or a concept.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

concept CodeableConcept? - Reference to a concept (by class)

reference Reference? - Reference to a resource (by instance)

health.fhir.r4: CodeableReferenceExtension

Closed record

Fields

url uri -

valueCodeableReference CodeableReference -

health.fhir.r4: CodeExtension

Closed record

Fields

url uri -

valueCode code -

health.fhir.r4: CodeSystem

FHIR CodeSystem resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_CODESYSTEM(default RESOURCE_NAME_CODESYSTEM) - The type of the resource describes

meta BaseCodeSystemMeta(default { profile : [PROFILE_BASE_CODESYSTEM] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime? - The date (and optionally time) when the code system was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the code system changes.

copyright markdown? - A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.

extension Extension[]? - 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.

valueSet canonical? - Canonical reference to the value set that contains the entire code system.

purpose markdown? - Explanation of why this code system is needed and why it has been designed as it has.

concept CodeSystemConcept[]? - Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are.

jurisdiction CodeableConcept[]? - A legal or geographic region in which the code system is intended to be used.

modifierExtension Extension[]? - 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).

description markdown? - A free text natural language description of the code system from a consumer's perspective.

experimental boolean? - A Boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language code? - The base language in which the resource is written.

title string? - A short, descriptive, user-friendly title for the code system.

content CodeSystemContent - The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.

hierarchyMeaning CodeSystemHierarchyMeaning? - The meaning of the hierarchy of concepts as represented in this resource.

contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.

property CodeSystemProperty[]? - A property defines an additional slot through which additional information can be provided about a concept.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

identifier Identifier[]? - A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.

caseSensitive boolean? - If code comparison is case sensitive when codes within this system are compared to each other.

versionNeeded boolean? - This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system.

count unsignedInt? - The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward.

'version string? - The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in Coding.version.

url uri? - An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this code system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the code system is stored on different servers. This is used in Coding.system.

filter CodeSystemFilter[]? - A filter that can be used in a value set compose statement when selecting concepts using a filter.

supplements canonical? - The canonical URL of the code system that this code system supplement is adding designations and properties to.

contained Resource[]? - 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.

compositional boolean? - The code system defines a compositional (post-coordination) grammar.

name string? - A natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher string? - The name of the organization or individual that published the code system.

useContext UsageContext[]? - 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 code system instances.

status CodeSystemStatus - The date (and optionally time) when the code system resource was created or revised.

never... - Rest field

health.fhir.r4: CodeSystemConcept

Closed record

FHIR CodeSystemConcept datatype record.

Fields

extension Extension[]? - 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.

code code - A code - a text symbol - that uniquely identifies the concept within the code system.

display string? - A human readable string that is the recommended default way to present this concept to a user.

modifierExtension Extension[]? - 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).

property CodeSystemConceptProperty[]? - A property value for this concept.

definition string? - The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept.

designation CodeSystemConceptDesignation[]? - Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: CodeSystemConceptDesignation

Closed record

FHIR CodeSystemConceptDesignation datatype record.

Fields

extension Extension[]? - 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.

use Coding? - A code that details how this designation would be used.

modifierExtension Extension[]? - 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).

language code? - The language this designation is defined for.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value string - The text value for this designation.

health.fhir.r4: CodeSystemConceptProperty

Closed record

FHIR CodeSystemConceptProperty datatype record.

Fields

valueCoding Coding - The value of this property.

valueBoolean boolean - The value of this property.

extension Extension[]? - 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.

code code - A code that is a reference to CodeSystem.property.code.

valueString string - The value of this property.

modifierExtension Extension[]? - 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).

valueDecimal decimal - The value of this property.

valueCode code - The value of this property.

valueDateTime dateTime - The value of this property.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer - The value of this property.

health.fhir.r4: CodeSystemFilter

Closed record

FHIR CodeSystemFilter datatype record.

Fields

extension Extension[]? - 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.

code code - The code that identifies this filter when it is used as a filter in ValueSet.compose.include.filter.

modifierExtension Extension[]? - 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).

description string? - A description of how or why the filter is used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value string - A description of what the value for the filter should be.

operator CodeSystemFilterOperator[] - A list of operators that can be used with the filter.

health.fhir.r4: CodeSystemProperty

Closed record

FHIR CodeSystemProperty datatype record.

Fields

extension Extension[]? - 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.

code code - A code that is used to identify the property. The code is used internally (in CodeSystem.concept.property.code) and also externally, such as in property filters.

modifierExtension Extension[]? - 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).

description string? - A description of the property- why it is defined, and how its value might be used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeSystemPropertyType - The type of the property value. Properties of type 'code' contain a code defined by the code system (e.g. a reference to another defined concept).

uri uri? - Reference to the formal meaning of the property. One possible source of meaning is the Concept Properties code system.

health.fhir.r4: Coding

Closed record

A Coding is a representation of a defined concept using a symbol from a defined "code system".

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

system uri? - Identity of the terminology system

'version string? - Version of the system - if relevant

code code? - Symbol in syntax defined by the system

display string? - Representation defined by the system

userSelected boolean? - If this coding was chosen directly by the user

health.fhir.r4: CodingExtension

Closed record

Fields

url uri -

valueCoding Coding -

health.fhir.r4: Communication

FHIR Communication resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_COMMUNICATION(default RESOURCE_NAME_COMMUNICATION) - The type of the resource describes

meta BaseCommunicationMeta(default { profile : [PROFILE_BASE_COMMUNICATION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

note Annotation[]? - Additional notes or commentary about the communication by the sender, receiver or other interested parties.

partOf Reference[]? - Part of this action.

extension Extension[]? - 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.

subject Reference? - The patient or group that was the focus of this communication.

modifierExtension Extension[]? - 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).

about Reference[]? - Other resources that pertain to this communication and to which this communication should be associated.

reasonReference Reference[]? - Indicates another resource whose existence justifies this communication.

language code? - The base language in which the resource is written.

medium CodeableConcept[]? - A channel that was used for this communication (e.g. email, fax).

instantiatesUri uri[]? - The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.

statusReason CodeableConcept? - Captures the reason for the current state of the Communication.

payload CommunicationPayload[]? - Text, attachment(s), or resource(s) that was communicated to the recipient.

inResponseTo Reference[]? - Prior communication that this communication is in response to.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

reasonCode CodeableConcept[]? - The reason or justification for the communication.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

basedOn Reference[]? - An order, proposal or plan fulfilled in whole or in part by this Communication.

identifier Identifier[]? - Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

received dateTime? - The time when this communication arrived at the destination.

encounter Reference? - The Encounter during which this Communication was created or to which the creation of this record is tightly associated.

instantiatesCanonical canonical[]? - The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.

priority CommunicationPriority? - Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.

sent dateTime? - The time when this communication was sent.

contained Resource[]? - 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.

sender Reference? - The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.

recipient Reference[]? - The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

topic CodeableConcept? - Description of the purpose/content, similar to a subject line in an email.

category CodeableConcept[]? - The type of message conveyed such as alert, notification, reminder, instruction, etc.

status CommunicationStatus - The status of the transmission.

never... - Rest field

health.fhir.r4: CommunicationPayload

Closed record

FHIR CommunicationPayload datatype record.

Fields

extension Extension[]? - 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.

contentReference Reference - A communicated content (or for multi-part communications, one portion of the communication).

contentString string - A communicated content (or for multi-part communications, one portion of the communication).

modifierExtension Extension[]? - 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).

contentAttachment Attachment - A communicated content (or for multi-part communications, one portion of the communication).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: CommunicationRequest

FHIR CommunicationRequest resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_COMMUNICATIONREQUEST(default RESOURCE_NAME_COMMUNICATIONREQUEST) - The type of the resource describes

meta BaseCommunicationRequestMeta(default { profile : [PROFILE_BASE_COMMUNICATIONREQUEST] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

note Annotation[]? - Comments made about the request by the requester, sender, recipient, subject or other participants.

extension Extension[]? - 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.

subject Reference? - The patient or group that is the focus of this communication request.

modifierExtension Extension[]? - 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).

about Reference[]? - Other resources that pertain to this communication request and to which this communication request should be associated.

reasonReference Reference[]? - Indicates another resource whose existence justifies this request.

language code? - The base language in which the resource is written.

medium CodeableConcept[]? - A channel that was used for this communication (e.g. email, fax).

statusReason CodeableConcept? - Captures the reason for the current state of the CommunicationRequest.

payload CommunicationRequestPayload[]? - Text, attachment(s), or resource(s) to be communicated to the recipient.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

reasonCode CodeableConcept[]? - Describes why the request is being made in coded or textual form.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

doNotPerform boolean? - If true indicates that the CommunicationRequest is asking for the specified action to not occur.

basedOn Reference[]? - A plan or proposal that is fulfilled in whole or in part by this request.

requester Reference? - The device, individual, or organization who initiated the request and has responsibility for its activation.

identifier Identifier[]? - Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

authoredOn dateTime? - For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.

replaces Reference[]? - Completed or terminated request(s) whose function is taken by this new request.

encounter Reference? - The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.

priority CommunicationRequestPriority? - Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.

contained Resource[]? - 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.

occurrencePeriod Period? - The time when this communication is to occur.

sender Reference? - The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.

recipient Reference[]? - The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

occurrenceDateTime dateTime? - The time when this communication is to occur.

category CodeableConcept[]? - The type of message to be sent such as alert, notification, reminder, instruction, etc.

groupIdentifier Identifier? - A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.

status CommunicationRequestStatus - The status of the proposal or order.

never... - Rest field

health.fhir.r4: CommunicationRequestPayload

Closed record

FHIR CommunicationRequestPayload datatype record.

Fields

extension Extension[]? - 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.

contentReference Reference - The communicated content (or for multi-part communications, one portion of the communication).

contentString string - The communicated content (or for multi-part communications, one portion of the communication).

modifierExtension Extension[]? - 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).

contentAttachment Attachment - The communicated content (or for multi-part communications, one portion of the communication).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: CompartmentDefinition

FHIR CompartmentDefinition resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_COMPARTMENTDEFINITION(default RESOURCE_NAME_COMPARTMENTDEFINITION) - The type of the resource describes

meta BaseCompartmentDefinitionMeta(default { profile : [PROFILE_BASE_COMPARTMENTDEFINITION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime? - The date (and optionally time) when the compartment definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the compartment definition changes.

extension Extension[]? - 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.

code CompartmentDefinitionCode - Which compartment this definition describes.

purpose markdown? - Explanation of why this compartment definition is needed and why it has been designed as it has.

'resource CompartmentDefinitionResource[]? - Information about how a resource is related to the compartment.

modifierExtension Extension[]? - 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).

description markdown? - A free text natural language description of the compartment definition from a consumer's perspective.

experimental boolean? - A Boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language code? - The base language in which the resource is written.

'version string? - The identifier that is used to identify this version of the compartment definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the compartment definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

url uri - An absolute URI that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this compartment definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the compartment definition is stored on different servers.

contained Resource[]? - 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.

search boolean - Whether the search syntax is supported,.

contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.

name string - A natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher string? - The name of the organization or individual that published the compartment definition.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

useContext UsageContext[]? - 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 compartment definition instances.

status CompartmentDefinitionStatus - The status of this compartment definition. Enables tracking the life-cycle of the content.

never... - Rest field

health.fhir.r4: CompartmentDefinitionResource

Closed record

FHIR CompartmentDefinitionResource datatype record.

Fields

extension Extension[]? - 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.

code code - The name of a resource supported by the server.

param string[]? - The name of a search parameter that represents the link to the compartment. More than one may be listed because a resource may be linked to a compartment in more than one way,.

documentation string? - Additional documentation about the resource and compartment.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: CompositeSearchParameter

Composite type search parameter information record.

Fields

Fields Included from *FHIRTypedSearchParameter

modifier "text-advanced"|"text"|"of-type"|"not-in"|"not"|"missing"|"iterate"|"in"|"identifier"|"exact"|"contains"|"code-text"|"below"|"above"|string|()
anydata...

valuereadonly string - Composite search parameter value

health.fhir.r4: Composition

FHIR Composition resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_COMPOSITION(default RESOURCE_NAME_COMPOSITION) - The type of the resource describes

meta BaseCompositionMeta(default { profile : [PROFILE_BASE_COMPOSITION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime - The composition editing time, when the composition was last logically changed by the author.

identifier Identifier? - A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.

extension Extension[]? - 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.

custodian Reference? - Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.

author Reference[] - Identifies who is responsible for the information in the composition, not necessarily who typed it in.

subject Reference? - Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).

confidentiality code? - The code specifying the level of confidentiality of the Composition.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

section CompositionSection[]? - The root of the sections that make up the composition.

encounter Reference? - Describes the clinical encounter or type of care this documentation is associated with.

title string - Official human-readable label for the composition.

'type CodeableConcept - Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.

attester CompositionAttester[]? - A participant who has attested to the accuracy of the composition/document.

contained Resource[]? - 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.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

category CodeableConcept[]? - A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.

event CompositionEvent[]? - The clinical service, such as a colonoscopy or an appendectomy, being documented.

relatesTo CompositionRelatesTo[]? - Relationships that this composition has with other compositions or documents that already exist.

status CompositionStatus - The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.

never... - Rest field

health.fhir.r4: CompositionAttester

Closed record

FHIR CompositionAttester datatype record.

Fields

mode CompositionAttesterMode - The type of attestation the authenticator offers.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

time dateTime? - When the composition was attested by the party.

party Reference? - Who attested the composition in the specified way.

health.fhir.r4: CompositionEvent

Closed record

FHIR CompositionEvent datatype record.

Fields

extension Extension[]? - 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.

period Period? - The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.

code CodeableConcept[]? - This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a 'History and Physical Report' in which the procedure being documented is necessarily a 'History and Physical' act.

modifierExtension Extension[]? - 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).

detail Reference[]? - The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: CompositionRelatesTo

Closed record

FHIR CompositionRelatesTo datatype record.

Fields

extension Extension[]? - 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.

targetIdentifier Identifier - The target composition/document of this relationship.

code CompositionRelatesToCode - The type of relationship that this composition has with anther composition or document.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

targetReference Reference - The target composition/document of this relationship.

health.fhir.r4: CompositionSection

Closed record

FHIR CompositionSection datatype record.

Fields

mode CompositionSectionMode? - How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

entry Reference[]? - A reference to the actual resource from which the narrative in the section is derived.

extension Extension[]? - 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.

code CodeableConcept? - A code identifying the kind of content contained within the section. This must be consistent with the section title.

emptyReason CodeableConcept? - If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

orderedBy CodeableConcept? - Specifies the order applied to the items in the section entries.

author Reference[]? - Identifies who is responsible for the information in this section, not necessarily who typed it in.

modifierExtension Extension[]? - 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).

focus Reference? - The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text Narrative? - A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative.

title string? - The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.

health.fhir.r4: ConceptMap

FHIR ConceptMap resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_CONCEPTMAP(default RESOURCE_NAME_CONCEPTMAP) - The type of the resource describes

meta BaseConceptMapMeta(default { profile : [PROFILE_BASE_CONCEPTMAP] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime? - The date (and optionally time) when the concept map was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the concept map changes.

copyright markdown? - A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map.

extension Extension[]? - 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.

purpose markdown? - Explanation of why this concept map is needed and why it has been designed as it has.

jurisdiction CodeableConcept[]? - A legal or geographic region in which the concept map is intended to be used.

modifierExtension Extension[]? - 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).

description markdown? - A free text natural language description of the concept map from a consumer's perspective.

experimental boolean? - A Boolean value to indicate that this concept map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language code? - The base language in which the resource is written.

title string? - A short, descriptive, user-friendly title for the concept map.

sourceUri uri? - Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings.

contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

group ConceptMapGroup[]? - A group of mappings that all have the same source and target system.

identifier Identifier? - A formal identifier that is used to identify this concept map when it is represented in other formats, or referenced in a specification, model, design or an instance.

sourceCanonical canonical? - Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings.

'version string? - The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the concept map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

url uri? - An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this concept map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the concept map is stored on different servers.

contained Resource[]? - 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.

name string? - A natural language name identifying the concept map. This name should be usable as an identifier for the module by machine processing applications such as code generation.

targetUri uri? - The target value set provides context for the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.

targetCanonical canonical? - The target value set provides context for the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher string? - The name of the organization or individual that published the concept map.

useContext UsageContext[]? - 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 concept map instances.

status ConceptMapStatus - The status of this concept map. Enables tracking the life-cycle of the content.

never... - Rest field

health.fhir.r4: ConceptMapGroup

Closed record

FHIR ConceptMapGroup datatype record.

Fields

extension Extension[]? - 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.

sourceVersion string? - The specific version of the code system, as determined by the code system authority.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'source uri? - An absolute URI that identifies the source system where the concepts to be mapped are defined.

unmapped ConceptMapGroupUnmapped? - What to do when there is no mapping for the source concept. 'Unmapped' does not include codes that are unmatched, and the unmapped element is ignored in a code is specified to have equivalence = unmatched.

element ConceptMapGroupElement[] - Mappings for an individual concept in the source to one or more concepts in the target.

target uri? - An absolute URI that identifies the target system that the concepts will be mapped to.

targetVersion string? - The specific version of the code system, as determined by the code system authority.

health.fhir.r4: ConceptMapGroupElement

Closed record

FHIR ConceptMapGroupElement datatype record.

Fields

extension Extension[]? - 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.

code code? - Identity (code or path) or the element/item being mapped.

display string? - The display for the code. The display is only provided to help editors when editing the concept map.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

target ConceptMapGroupElementTarget[]? - A concept from the target value set that this concept maps to.

health.fhir.r4: ConceptMapGroupElementTarget

Closed record

FHIR ConceptMapGroupElementTarget datatype record.

Fields

equivalence ConceptMapGroupElementTargetEquivalence - The equivalence between the source and target concepts (counting for the dependencies and products). The equivalence is read from target to source (e.g. the target is 'wider' than the source).

extension Extension[]? - 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.

code code? - Identity (code or path) or the element/item that the map refers to.

dependsOn ConceptMapGroupElementTargetDependsOn[]? - A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified element can be resolved, and it has the specified value.

display string? - The display for the code. The display is only provided to help editors when editing the concept map.

modifierExtension Extension[]? - 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).

comment string? - A description of status/issues in mapping that conveys additional information not represented in the structured data.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ConceptMapGroupElementTargetDependsOn

Closed record

FHIR ConceptMapGroupElementTargetDependsOn datatype record.

Fields

extension Extension[]? - 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.

system canonical? - An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that crosses code systems).

display string? - The display for the code. The display is only provided to help editors when editing the concept map.

modifierExtension Extension[]? - 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).

property uri - A reference to an element that holds a coded value that corresponds to a code system property. The idea is that the information model carries an element somewhere that is labeled to correspond with a code system property.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value string - Identity (code or path) or the element/item/ValueSet/text that the map depends on / refers to.

health.fhir.r4: ConceptMapGroupUnmapped

Closed record

FHIR ConceptMapGroupUnmapped datatype record.

Fields

mode ConceptMapGroupUnmappedMode - Defines which action to take if there is no match for the source concept in the target system designated for the group. One of 3 actions are possible: use the unmapped code (this is useful when doing a mapping between versions, and only a few codes have changed), use a fixed code (a default code), or alternatively, a reference to a different concept map can be provided (by canonical URL).

extension Extension[]? - 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.

code code? - The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code.

display string? - The display for the code. The display is only provided to help editors when editing the concept map.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

url canonical? - The canonical reference to an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source concept.

health.fhir.r4: Condition

FHIR Condition resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_CONDITION(default RESOURCE_NAME_CONDITION) - The type of the resource describes

meta BaseConditionMeta(default { profile : [PROFILE_BASE_CONDITION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

note Annotation[]? - Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.

extension Extension[]? - 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.

code CodeableConcept? - Identification of the condition, problem or diagnosis.

evidence ConditionEvidence[]? - Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.

onsetRange Range? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.

abatementDateTime dateTime? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.

subject Reference - Indicates the patient or group who the condition record is associated with.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

clinicalStatus CodeableConcept? - The clinical status of the condition.

onsetDateTime dateTime? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.

onsetString string? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.

onsetAge Age? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.

abatementPeriod Period? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

abatementString string? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.

severity CodeableConcept? - A subjective assessment of the severity of the condition as evaluated by the clinician.

identifier Identifier[]? - Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

recorder Reference? - Individual who recorded the record and takes responsibility for its content.

onsetPeriod Period? - Estimated or actual date or date-time the condition began, in the opinion of the clinician.

verificationStatus CodeableConcept? - The verification status to support the clinical status of the condition.

recordedDate dateTime? - The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.

abatementRange Range? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.

encounter Reference? - The Encounter during which this Condition was created or to which the creation of this record is tightly associated.

bodySite CodeableConcept[]? - The anatomical location where this condition manifests itself.

contained Resource[]? - 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.

asserter Reference? - Individual who is making the condition statement.

stage ConditionStage[]? - Clinical stage or grade of a condition. May include formal severity assessments.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[]? - A category assigned to the condition.

abatementAge Age? - The date or estimated date that the condition resolved or went into remission. This is called 'abatement' because of the many overloaded connotations associated with 'remission' or 'resolution' - Conditions are never really resolved, but they can abate.

never... - Rest field

health.fhir.r4: ConditionEvidence

Closed record

FHIR ConditionEvidence datatype record.

Fields

extension Extension[]? - 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.

code CodeableConcept[]? - A manifestation or symptom that led to the recording of this condition.

modifierExtension Extension[]? - 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).

detail Reference[]? - Links to other relevant information, including pathology reports.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ConditionStage

Closed record

FHIR ConditionStage datatype record.

Fields

summary CodeableConcept? - A simple summary of the stage such as 'Stage 3'. The determination of the stage is disease-specific.

assessment Reference[]? - Reference to a formal record of the evidence on which the staging assessment is based.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept? - The kind of staging, such as pathological or clinical staging.

FHIR Consent resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_CONSENT(default RESOURCE_NAME_CONSENT) - The type of the resource describes

meta BaseConsentMeta(default { profile : [PROFILE_BASE_CONSENT] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

dateTime dateTime? - When this Consent was issued / created / indexed.

sourceReference Reference? - The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.

identifier Identifier[]? - Unique identifier for this copy of the Consent Statement.

extension Extension[]? - 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.

performer Reference[]? - Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.

modifierExtension Extension[]? - 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).

sourceAttachment Attachment? - The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.

language code? - The base language in which the resource is written.

contained Resource[]? - 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.

policyRule CodeableConcept? - A reference to the specific base computable regulation or policy.

patient Reference? - The patient/healthcare consumer to whom this consent applies.

provision ConsentProvision? - An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.

organization Reference[]? - The organization that manages the consent, and the framework within which it is executed.

scope CodeableConcept - A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

category CodeableConcept[] - A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.

verification ConsentVerification[]? - Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person.

policy ConsentPolicy[]? - The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.

status ConsentStatus - Indicates the current state of this consent.

never... - Rest field

health.fhir.r4: ConsentPolicy

Closed record

FHIR ConsentPolicy datatype record.

Fields

extension Extension[]? - 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.

authority uri? - Entity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

uri uri? - The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.

health.fhir.r4: ConsentProvision

Closed record

FHIR ConsentProvision datatype record.

Fields

dataPeriod Period? - Clinical or Operational Relevant period of time that bounds the data controlled by this rule.

extension Extension[]? - 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.

period Period? - The timeframe in this rule is valid.

code CodeableConcept[]? - If this code is found in an instance, then the rule applies.

data ConsentProvisionData[]? - The resources controlled by this rule if specific resources are referenced.

purpose Coding[]? - The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule.

securityLabel Coding[]? - A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.

modifierExtension Extension[]? - 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).

'type ConsentProvisionType? - Action to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules.

actor ConsentProvisionActor[]? - Who or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').

action CodeableConcept[]? - Actions controlled by this Rule.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'class Coding[]? - The class of information covered by this rule. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to.

health.fhir.r4: ConsentProvisionActor

Closed record

FHIR ConsentProvisionActor datatype record.

Fields

reference Reference - The resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers').

extension Extension[]? - 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.

role CodeableConcept - How the individual is involved in the resources content that is described in the exception.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ConsentProvisionData

Closed record

FHIR ConsentProvisionData datatype record.

Fields

reference Reference - A reference to a specific resource that defines which resources are covered by this consent.

extension Extension[]? - 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.

meaning ConsentProvisionDataMeaning - How the resource reference is interpreted when testing consent restrictions.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ConsentVerification

Closed record

FHIR ConsentVerification datatype record.

Fields

extension Extension[]? - 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.

verifiedWith Reference? - Who verified the instruction (Patient, Relative or other Authorized Person).

modifierExtension Extension[]? - 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).

verified boolean - Has the instruction been verified.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

verificationDate dateTime? - Date verification was collected.

health.fhir.r4: ContactDetail

Closed record

The ContactDetail structure defines general contact details.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

name string? - Name of an individual to contact

telecom ContactPoint[]? - Contact details for individual or organization

health.fhir.r4: ContactDetailExtension

Closed record

Fields

url uri -

valueContactDetail ContactDetail -

health.fhir.r4: ContactPoint

Closed record

Details for all kinds of technology-mediated contact points for a person or organization, including telephone, email, etc.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

system ContactPointSystem? - [ phone | fax | email | pager | url | sms | other ] ContactPointSystem (Required) (http://hl7.org/fhir/valueset-contact-point-system.html)

value string? - The actual contact point details

use ContactPointUse? - [ home | work | temp | old | mobile ] - purpose of this contact point. ContactPointUse (Required) (http://hl7.org/fhir/valueset-contact-point-use.html)

rank positiveInt? - Specify preferred order of use (1 = highest)

period Period? - Time period when the contact point was/is in use

health.fhir.r4: ContactPointExtension

Closed record

Fields

url uri -

valueContactPoint ContactPoint -

health.fhir.r4: ContainerDefinitionRecord

Represents definition of a FHIR resource.

Fields

name string - Name of the resource

baseType typedesc - Type of the resource / abstract resource that is based on

profile string - profile url

elements map<ElementAnnotationDefinition> - element definitions contained in the resource

serializers ContainerSerializerCollection - Serializers of the resource

validator ResourceTypeValidationFunction? - Validator for the resource

processingMetaInfo ProcessingMetaInfo? - Meta information for processing the resource (This is included in intermediate user friendly FHIR models)

health.fhir.r4: ContainerSerializerCollection

Resource Serializer Collection.

Fields

'xml ContainerSerializerFunction - xml serializer

'json ContainerSerializerFunction - json serializer

health.fhir.r4: Contract

FHIR Contract resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_CONTRACT(default RESOURCE_NAME_CONTRACT) - The type of the resource describes

meta BaseContractMeta(default { profile : [PROFILE_BASE_CONTRACT] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

extension Extension[]? - 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.

friendly ContractFriendly[]? - The 'patient friendly language' versionof the Contract in whole or in parts. 'Patient friendly language' means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.

subject Reference[]? - The target entity impacted by or of interest to parties to the agreement.

modifierExtension Extension[]? - 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).

rule ContractRule[]? - List of Computable Policy Rule Language Representations of this Contract.

language code? - The base language in which the resource is written.

title string? - A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.

'type CodeableConcept? - A high-level category for the legal instrument, whether constructed as a Contract definition, derivative, or instance in any legal state. Provides additional information about its content within the context of the Contract's scope to distinguish the kinds of systems that would be interested in the contract.

instantiatesUri uri? - The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract.

relevantHistory Reference[]? - Links to Provenance records for past versions of this Contract definition, derivative, or instance, which identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the Contract. The Provence.entity indicates the target that was changed in the update. http://build.fhir.org/provenance-definitions.html#Provenance.entity.

supportingInfo Reference[]? - Information that may be needed by/relevant to the performer in their execution of this term action.

topicReference Reference? - Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.

contentDefinition ContractContentDefinition? - Precusory content developed with a focus and intent of supporting the formation a Contract instance, which may be associated with and transformable into a Contract.

scope CodeableConcept? - A selector of legal concerns for this Contract definition, derivative, or instance in any legal state.

legal ContractLegal[]? - List of Legal expressions or representations of this Contract.

alias string[]? - Alternative representation of the title for this Contract definition, derivative, or instance in any legal state., e.g., a domain specific contract number related to legislation.

term ContractTerm[]? - One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued dateTime? - When this Contract was issued.

contentDerivative CodeableConcept? - The minimal content derived from the basal information source at a specific stage in its lifecycle.

signer ContractSigner[]? - Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness.

identifier Identifier[]? - Unique identifier for this Contract or a derivative that references a Source Contract.

expirationType CodeableConcept? - Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract.

legallyBindingAttachment Attachment? - Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the 'source of truth' and which would be the basis for legal action related to enforcement of this Contract.

author Reference? - The individual or organization that authored the Contract definition, derivative, or instance in any legal state.

topicCodeableConcept CodeableConcept? - Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.

instantiatesCanonical Reference? - The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.

'version string? - An edition identifier used for business purposes to label business significant variants.

url uri? - Canonical identifier for this contract, represented as a URI (globally unique).

contained Resource[]? - 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.

site Reference[]? - Sites in which the contract is complied with, exercised, or in force.

applies Period? - Relevant time or time-period when this Contract is applicable.

authority Reference[]? - A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.

domain Reference[]? - Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.

subtitle string? - An explanatory or alternate user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.

name string? - A natural language name identifying this Contract definition, derivative, or instance in any legal state. Provides additional information about its content. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

subType CodeableConcept[]? - Sub-category for the Contract that distinguishes the kinds of systems that would be interested in the Contract within the context of the Contract's scope.

legalState CodeableConcept? - Legal states of the formation of a legal instrument, which is a formally executed written document that can be formally attributed to its author, records and formally expresses a legally enforceable act, process, or contractual duty, obligation, or right, and therefore evidences that act, process, or agreement.

legallyBindingReference Reference? - Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the 'source of truth' and which would be the basis for legal action related to enforcement of this Contract.

status ContractStatus? - The status of the resource instance.

never... - Rest field

health.fhir.r4: ContractContentDefinition

Closed record

FHIR ContractContentDefinition datatype record.

Fields

publicationStatus ContractContentDefinitionPublicationStatus - amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated.

copyright markdown? - A copyright statement relating to Contract precursor content. Copyright statements are generally legal restrictions on the use and publishing of the Contract precursor content.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

publisher Reference? - The individual or organization that published the Contract precursor content.

subType CodeableConcept? - Detailed Precusory content type.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - Precusory content structure and use, i.e., a boilerplate, template, application for a contract such as an insurance policy or benefits under a program, e.g., workers compensation.

publicationDate dateTime? - The date (and optionally time) when the contract was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the contract changes.

health.fhir.r4: ContractFriendly

Closed record

FHIR ContractFriendly datatype record.

Fields

extension Extension[]? - 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.

contentReference Reference - Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability.

modifierExtension Extension[]? - 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).

contentAttachment Attachment - Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ContractLegal

Closed record

FHIR ContractLegal datatype record.

Fields

extension Extension[]? - 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.

contentReference Reference - Contract legal text in human renderable form.

modifierExtension Extension[]? - 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).

contentAttachment Attachment - Contract legal text in human renderable form.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ContractRule

Closed record

FHIR ContractRule datatype record.

Fields

extension Extension[]? - 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.

contentReference Reference - Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal).

modifierExtension Extension[]? - 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).

contentAttachment Attachment - Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ContractSigner

Closed record

FHIR ContractSigner datatype record.

Fields

extension Extension[]? - 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.

signature Signature[] - Legally binding Contract DSIG signature contents in Base64.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type Coding - Role of this Contract signer, e.g. notary, grantee.

party Reference - Party which is a signator to this Contract.

health.fhir.r4: ContractTerm

Closed record

FHIR ContractTerm datatype record.

Fields

identifier Identifier? - Unique identifier for this particular Contract Provision.

extension Extension[]? - 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.

securityLabel ContractTermSecurityLabel[]? - Security labels that protect the handling of information about the term and its elements, which may be specifically identified..

modifierExtension Extension[]? - 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).

topicCodeableConcept CodeableConcept? - The entity that the term applies to.

'type CodeableConcept? - A legal clause or condition contained within a contract that requires one or both parties to perform a particular requirement by some specified time or prevents one or both parties from performing a particular requirement by some specified time.

offer ContractTermOffer - The matter of concern in the context of this provision of the agrement.

applies Period? - Relevant time or time-period when this Contract Provision is applicable.

topicReference Reference? - The entity that the term applies to.

action ContractTermAction[]? - An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.

subType CodeableConcept? - A specialized legal clause or condition based on overarching contract type.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Statement of a provision in a policy or a contract.

asset ContractTermAsset[]? - Contract Term Asset List.

issued dateTime? - When this Contract Provision was issued.

health.fhir.r4: ContractTermAction

Closed record

FHIR ContractTermAction datatype record.

Fields

note Annotation[]? - Comments made about the term action made by the requester, performer, subject or other participants.

reason string[]? - Describes why the action is to be performed or not performed in textual form.

extension Extension[]? - 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.

subject ContractTermActionSubject[]? - Entity of the action.

modifierExtension Extension[]? - 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).

reasonReference Reference[]? - Indicates another resource whose existence justifies permitting or not permitting this action.

performerLinkId string[]? - Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.

'type CodeableConcept - Activity or service obligation to be done or not done, performed or not performed, effectuated or not by this Contract term.

contextLinkId string[]? - Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.

context Reference? - Encounter or Episode with primary association to specified term activity.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

reasonCode CodeableConcept[]? - Rationale for the action to be performed or not performed. Describes why the action is permitted or prohibited.

doNotPerform boolean? - True if the term prohibits the action.

requester Reference[]? - Who or what initiated the action and has responsibility for its activation.

performer Reference? - Indicates who or what is being asked to perform (or not perform) the ction.

performerRole CodeableConcept? - The type of role or competency of an individual desired or required to perform or not perform the action.

securityLabelNumber unsignedInt[]? - Security labels that protects the action.

occurrenceTiming Timing? - When action happens.

intent CodeableConcept - Reason or purpose for the action stipulated by this Contract Provision.

performerType CodeableConcept[]? - The type of individual that is desired or required to perform or not perform the action.

requesterLinkId string[]? - Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.

linkId string[]? - Id [identifier??] of the clause or question text related to this action in the referenced form or QuestionnaireResponse.

occurrencePeriod Period? - When action happens.

occurrenceDateTime dateTime? - When action happens.

reasonLinkId string[]? - Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.

status CodeableConcept - Current state of the term action.

health.fhir.r4: ContractTermActionSubject

Closed record

FHIR ContractTermActionSubject datatype record.

Fields

reference Reference[] - The entity the action is performed or not performed on or for.

extension Extension[]? - 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.

role CodeableConcept? - Role type of agent assigned roles in this Contract.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ContractTermAsset

Closed record

FHIR ContractTermAsset datatype record.

Fields

extension Extension[]? - 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.

period Period[]? - Asset relevant contractual time period.

usePeriod Period[]? - Time period of asset use.

modifierExtension Extension[]? - 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).

securityLabelNumber unsignedInt[]? - Security labels that protects the asset.

'type CodeableConcept[]? - Target entity type about which the term may be concerned.

condition string? - Description of the quality and completeness of the asset that imay be a factor in its valuation.

linkId string[]? - Id [identifier??] of the clause or question text about the asset in the referenced form or QuestionnaireResponse.

periodType CodeableConcept[]? - Type of Asset availability for use or ownership.

subtype CodeableConcept[]? - May be a subtype or part of an offered asset.

scope CodeableConcept? - Differentiates the kind of the asset .

context ContractTermAssetContext[]? - Circumstance of the asset.

typeReference Reference[]? - Associated entities.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Clause or question text (Prose Object) concerning the asset in a linked form, such as a QuestionnaireResponse used in the formation of the contract.

valuedItem ContractTermAssetValuedItem[]? - Contract Valued Item List.

relationship Coding? - Specifies the applicability of the term to an asset resource instance, and instances it refers to orinstances that refer to it, and/or are owned by the offeree.

health.fhir.r4: ContractTermAssetContext

Closed record

FHIR ContractTermAssetContext datatype record.

Fields

reference Reference? - Asset context reference may include the creator, custodian, or owning Person or Organization (e.g., bank, repository), location held, e.g., building, jurisdiction.

extension Extension[]? - 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.

code CodeableConcept[]? - Coded representation of the context generally or of the Referenced entity, such as the asset holder type or location.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Context description.

health.fhir.r4: ContractTermAssetValuedItem

Closed record

FHIR ContractTermAssetValuedItem datatype record.

Fields

unitPrice Money? - A Contract Valued Item unit valuation measure.

identifier Identifier? - Identifies a Contract Valued Item instance.

extension Extension[]? - 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.

quantity Quantity? - Specifies the units by which the Contract Valued Item is measured or counted, and quantifies the countable or measurable Contract Valued Item instances.

effectiveTime dateTime? - Indicates the time during which this Contract ValuedItem information is effective.

modifierExtension Extension[]? - 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).

entityCodeableConcept CodeableConcept? - Specific type of Contract Valued Item that may be priced.

securityLabelNumber unsignedInt[]? - A set of security labels that define which terms are controlled by this condition.

points decimal? - An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Valued Item delivered. The concept of Points allows for assignment of point values for a Contract Valued Item, such that a monetary amount can be assigned to each point.

linkId string[]? - Id of the clause or question text related to the context of this valuedItem in the referenced form or QuestionnaireResponse.

entityReference Reference? - Specific type of Contract Valued Item that may be priced.

responsible Reference? - Who will make payment.

recipient Reference? - Who will receive payment.

payment string? - Terms of valuation.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

factor decimal? - A real number that represents a multiplier used in determining the overall value of the Contract Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net Money? - Expresses the product of the Contract Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.

paymentDate dateTime? - When payment is due.

health.fhir.r4: ContractTermOffer

Closed record

FHIR ContractTermOffer datatype record.

Fields

identifier Identifier[]? - Unique identifier for this particular Contract Provision.

extension Extension[]? - 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.

decision CodeableConcept? - Type of choice made by accepting party with respect to an offer made by an offeror/ grantee.

modifierExtension Extension[]? - 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).

securityLabelNumber unsignedInt[]? - Security labels that protects the offer.

'type CodeableConcept? - Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit.

linkId string[]? - The id of the clause or question text of the offer in the referenced questionnaire/response.

answer ContractTermOfferAnswer[]? - Response to offer text.

decisionMode CodeableConcept[]? - How the decision about a Contract was conveyed.

topic Reference? - The owner of an asset has the residual control rights over the asset: the right to decide all usages of the asset in any way not inconsistent with a prior contract, custom, or law (Hart, 1995, p. 30).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Human readable form of this Contract Offer.

party ContractTermOfferParty[]? - Offer Recipient.

health.fhir.r4: ContractTermOfferAnswer

Closed record

FHIR ContractTermOfferAnswer datatype record.

Fields

valueBoolean boolean - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.

valueCoding Coding - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.

extension Extension[]? - 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.

valueTime time - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.

valueReference Reference - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.

modifierExtension Extension[]? - 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).

valueDecimal decimal - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.

valueUri uri - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.

valueDate date - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.

valueAttachment Attachment - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.

valueString string - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.

valueDateTime dateTime - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.

valueQuantity Quantity - Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.

health.fhir.r4: ContractTermOfferParty

Closed record

FHIR ContractTermOfferParty datatype record.

Fields

reference Reference[] - Participant in the offer.

extension Extension[]? - 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.

role CodeableConcept - How the party participates in the offer.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ContractTermSecurityLabel

Closed record

FHIR ContractTermSecurityLabel datatype record.

Fields

number unsignedInt[]? - Number used to link this term or term element to the applicable Security Label.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

control Coding[]? - Security label privacy tag that species the manner in which term and/or term elements are to be protected.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category Coding[]? - Security label privacy tag that species the applicable privacy and security policies governing this term and/or term elements.

classification Coding - Security label privacy tag that species the level of confidentiality protection required for this term and/or term elements.

health.fhir.r4: Contributer

Closed record

Contributor information Elements defined in Ancestors: id, extension

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

'type ContributerType - author | editor | reviewer | endorser ContributorType (Required)

name string - Who contributed the content

contact ContactDetail[]? - Contact details of the contributor

health.fhir.r4: Contributor

Closed record

Contributor information Elements defined in Ancestors: id, extension.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

'type ContributorType - author | editor | reviewer | endorser ContributorType (Required)

name string - Who contributed the content

contact ContactDetail[]? - Contact details of the contributor

health.fhir.r4: Count

Closed record

Fields

Fields Included from *Quantity

id string
extension Extension[]
value decimal
comparator QuantityComparatorCode
unit string
system uri
code code
Element...

id string? -

extension Extension[]? -

countValue integer? -

unit string? -

system uri? -

code code? -

health.fhir.r4: CountExtension

Closed record

Fields

url uri -

valueCount Count -

health.fhir.r4: Coverage

FHIR Coverage resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_COVERAGE(default RESOURCE_NAME_COVERAGE) - The type of the resource describes

meta BaseCoverageMeta(default { profile : [PROFILE_BASE_COVERAGE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

extension Extension[]? - 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.

subrogation boolean? - When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

'type CodeableConcept? - The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.

network string? - The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.

payor Reference[] - The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

relationship CodeableConcept? - The relationship of beneficiary (patient) to the subscriber.

'class CoverageClass[]? - A suite of underwriter specific classifiers.

dependent string? - A unique identifier for a dependent under the coverage.

'order positiveInt? - The order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care.

identifier Identifier[]? - A unique identifier assigned to this coverage.

costToBeneficiary CoverageCostToBeneficiary[]? - A suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card.

period Period? - Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.

subscriber Reference? - The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.

contract Reference[]? - The policy(s) which constitute this insurance coverage.

subscriberId string? - The insurer assigned ID for the Subscriber.

contained Resource[]? - 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.

beneficiary Reference - The party who benefits from the insurance coverage; the patient when products and/or services are provided.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

policyHolder Reference? - The party who 'owns' the insurance policy.

status CoverageStatus - The status of the resource instance.

never... - Rest field

health.fhir.r4: CoverageClass

Closed record

FHIR CoverageClass datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

name string? - A short description for the class.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - The type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan.

value string - The alphanumeric string value associated with the insurer issued label.

health.fhir.r4: CoverageCostToBeneficiary

Closed record

FHIR CoverageCostToBeneficiary datatype record.

Fields

exception CoverageCostToBeneficiaryException[]? - A suite of codes indicating exceptions or reductions to patient costs and their effective periods.

extension Extension[]? - 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.

valueMoney Money - The amount due from the patient for the cost category.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept? - The category of patient centric costs associated with treatment.

valueQuantity Quantity - The amount due from the patient for the cost category.

health.fhir.r4: CoverageCostToBeneficiaryException

Closed record

FHIR CoverageCostToBeneficiaryException datatype record.

Fields

extension Extension[]? - 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.

period Period? - The timeframe during when the exception is in force.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - The code for the specific exception.

health.fhir.r4: CoverageEligibilityRequest

FHIR CoverageEligibilityRequest resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_COVERAGEELIGIBILITYREQUEST(default RESOURCE_NAME_COVERAGEELIGIBILITYREQUEST) - The type of the resource describes

meta BaseCoverageEligibilityRequestMeta(default { profile : [PROFILE_BASE_COVERAGEELIGIBILITYREQUEST] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

insurance CoverageEligibilityRequestInsurance[]? - Financial instruments for reimbursement for the health care products and services.

identifier Identifier[]? - A unique identifier assigned to this coverage eligiblity request.

extension Extension[]? - 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.

item CoverageEligibilityRequestItem[]? - Service categories or billable services for which benefit details and/or an authorization prior to service delivery may be required by the payor.

purpose CoverageEligibilityRequestPurpose[] - Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified.

created dateTime - The date when this resource was created.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

priority CodeableConcept? - When the requestor expects the processor to complete processing.

servicedPeriod Period? - The date or dates when the enclosed suite of services were performed or completed.

contained Resource[]? - 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.

supportingInfo CoverageEligibilityRequestSupportingInfo[]? - Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.

provider Reference? - The provider which is responsible for the request.

insurer Reference - The Insurer who issued the coverage in question and is the recipient of the request.

patient Reference - The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.

enterer Reference? - Person who created the request.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

servicedDate date? - The date or dates when the enclosed suite of services were performed or completed.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

facility Reference? - Facility where the services are intended to be provided.

status CoverageEligibilityRequestStatus - The status of the resource instance.

never... - Rest field

health.fhir.r4: CoverageEligibilityRequestInsurance

Closed record

FHIR CoverageEligibilityRequestInsurance datatype record.

Fields

coverage Reference - Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.

extension Extension[]? - 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.

businessArrangement string? - A business agreement number established between the provider and the insurer for special business processing purposes.

focal boolean? - A flag to indicate that this Coverage is to be used for evaluation of this request when set to true.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: CoverageEligibilityRequestItem

Closed record

FHIR CoverageEligibilityRequestItem datatype record.

Fields

unitPrice Money? - The amount charged to the patient by the provider for a single unit.

extension Extension[]? - 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.

quantity Quantity? - The number of repetitions of a service or product.

modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension Extension[]? - 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).

diagnosis CoverageEligibilityRequestItemDiagnosis[]? - Patient diagnosis for which care is sought.

productOrService CodeableConcept? - This contains the product, service, drug or other billing code for the item.

provider Reference? - The practitioner who is responsible for the product or service to be rendered to the patient.

supportingInfoSequence positiveInt[]? - Exceptions, special conditions and supporting information applicable for this service or product line.

detail Reference[]? - The plan/proposal/order describing the proposed service in detail.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category CodeableConcept? - Code to identify the general type of benefits under which products and services are provided.

facility Reference? - Facility where the services will be provided.

health.fhir.r4: CoverageEligibilityRequestItemDiagnosis

Closed record

FHIR CoverageEligibilityRequestItemDiagnosis datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

diagnosisReference Reference? - The nature of illness or problem in a coded form or as a reference to an external defined Condition.

diagnosisCodeableConcept CodeableConcept? - The nature of illness or problem in a coded form or as a reference to an external defined Condition.

health.fhir.r4: CoverageEligibilityRequestSupportingInfo

Closed record

FHIR CoverageEligibilityRequestSupportingInfo datatype record.

Fields

sequence positiveInt - A number to uniquely identify supporting information entries.

extension Extension[]? - 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.

appliesToAll boolean? - The supporting materials are applicable for all detail items, product/servce categories and specific billing codes.

modifierExtension Extension[]? - 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).

information Reference - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: CoverageEligibilityResponse

FHIR CoverageEligibilityResponse resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_COVERAGEELIGIBILITYRESPONSE(default RESOURCE_NAME_COVERAGEELIGIBILITYRESPONSE) - The type of the resource describes

meta BaseCoverageEligibilityResponseMeta(default { profile : [PROFILE_BASE_COVERAGEELIGIBILITYRESPONSE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

insurance CoverageEligibilityResponseInsurance[]? - Financial instruments for reimbursement for the health care products and services.

identifier Identifier[]? - A unique identifier assigned to this coverage eligiblity request.

request Reference - Reference to the original request resource.

extension Extension[]? - 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.

purpose CoverageEligibilityResponsePurpose[] - Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified.

created dateTime - The date this resource was created.

modifierExtension Extension[]? - 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).

preAuthRef string? - A reference from the Insurer to which these services pertain to be used on further communication and as proof that the request occurred.

language code? - The base language in which the resource is written.

'error CoverageEligibilityResponseError[]? - Errors encountered during the processing of the request.

servicedPeriod Period? - The date or dates when the enclosed suite of services were performed or completed.

requestor Reference? - The provider which is responsible for the request.

contained Resource[]? - 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.

disposition string? - A human readable description of the status of the adjudication.

form CodeableConcept? - A code for the form to be used for printing the content.

insurer Reference - The Insurer who issued the coverage in question and is the author of the response.

patient Reference - The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

servicedDate date? - The date or dates when the enclosed suite of services were performed or completed.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

outcome CoverageEligibilityResponseOutcome - The outcome of the request processing.

status CoverageEligibilityResponseStatus - The status of the resource instance.

never... - Rest field

health.fhir.r4: CoverageEligibilityResponseError

Closed record

FHIR CoverageEligibilityResponseError datatype record.

Fields

extension Extension[]? - 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.

code CodeableConcept - An error code,from a specified code system, which details why the eligibility check could not be performed.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: CoverageEligibilityResponseInsurance

Closed record

FHIR CoverageEligibilityResponseInsurance datatype record.

Fields

benefitPeriod Period? - The term of the benefits documented in this response.

coverage Reference - Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.

extension Extension[]? - 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.

inforce boolean? - Flag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates.

item CoverageEligibilityResponseInsuranceItem[]? - Benefits and optionally current balances, and authorization details by category or service.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: CoverageEligibilityResponseInsuranceItem

Closed record

FHIR CoverageEligibilityResponseInsuranceItem datatype record.

Fields

extension Extension[]? - 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.

modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension Extension[]? - 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).

authorizationSupporting CodeableConcept[]? - Codes or comments regarding information or actions associated with the preauthorization.

description string? - A richer description of the benefit or services covered.

productOrService CodeableConcept? - This contains the product, service, drug or other billing code for the item.

benefit CoverageEligibilityResponseInsuranceItemBenefit[]? - Benefits used to date.

network CodeableConcept? - Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.

excluded boolean? - True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.

unit CodeableConcept? - Indicates if the benefits apply to an individual or to the family.

authorizationUrl uri? - A web location for obtaining requirements or descriptive information regarding the preauthorization.

authorizationRequired boolean? - A boolean flag indicating whether a preauthorization is required prior to actual service delivery.

provider Reference? - The practitioner who is eligible for the provision of the product or service.

name string? - A short name or tag for the benefit.

term CodeableConcept? - The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category CodeableConcept? - Code to identify the general type of benefits under which products and services are provided.

health.fhir.r4: CoverageEligibilityResponseInsuranceItemBenefit

Closed record

FHIR CoverageEligibilityResponseInsuranceItemBenefit datatype record.

Fields

usedString string? - The quantity of the benefit which have been consumed to date.

allowedMoney Money? - The quantity of the benefit which is permitted under the coverage.

extension Extension[]? - 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.

allowedString string? - The quantity of the benefit which is permitted under the coverage.

allowedUnsignedInt unsignedInt? - The quantity of the benefit which is permitted under the coverage.

usedUnsignedInt unsignedInt? - The quantity of the benefit which have been consumed to date.

modifierExtension Extension[]? - 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).

usedMoney Money? - The quantity of the benefit which have been consumed to date.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - Classification of benefit being provided.

health.fhir.r4: DataRequirement

Describes a required data item.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

'type code - The type of the required data

profile canonical[]? - The profile of the required data

subjectCodeableConcept CodeableConcept? - Patient, Practitioner, RelatedPerson, Organization, Location, Device

subjectReference Reference? - Patient, Practitioner, RelatedPerson, Organization, Location, Device

mustSupport string[]? - Indicates specific structure elements that are referenced by the knowledge module

codeFilter ElementCodeFilter[]? - What codes are expected

dateFilter ElementDateFilter[]? - What dates/date ranges are expected

'limit positiveInt? - Number of results

sort ElementSort[]? - Order of the results

health.fhir.r4: DataRequirementExtension

Closed record

Fields

url uri -

valueDataRequirement DataRequirement -

health.fhir.r4: DataTypeDefinitionRecord

Definition if a FHIR complex data type.

Fields

name string - Name of the data type

baseType typedesc - Base Data type that this data type is based on (extended from)

elements map<ElementAnnotationDefinition> - Child elements of the defined data type

serializers DataTypeSerializerCollection - Serializer of the data type

validator DataTypeValidationFunction? - Validator for the data type

processingMetaInfo ProcessingMetaInfo? - Meta information for processing the data entry (This is included in intermediate user friendly FHIR models)

health.fhir.r4: DataTypeSerializerCollection

Data type serializer collection.

Fields

'xml DataTypeSerializerFunction - xml serializer

'json DataTypeSerializerFunction - json serializer

health.fhir.r4: DateExtension

Closed record

Fields

url uri -

valueDate date -

health.fhir.r4: DateSearchParameter

Date type search parameter information.

Fields

Fields Included from *FHIRTypedSearchParameter

modifier "text-advanced"|"text"|"of-type"|"not-in"|"not"|"missing"|"iterate"|"in"|"identifier"|"exact"|"contains"|"code-text"|"below"|"above"|string|()
anydata...

prefixreadonly Prefix - Prefix attached with date type search parameter

valuereadonly Civil - Value of the received search parameter

health.fhir.r4: DateTimeExtension

Closed record

Fields

url uri -

valueDateTime dateTime -

health.fhir.r4: DecimalExtension

Closed record

Fields

url uri -

valueDecimal decimal -

health.fhir.r4: DetectedIssue

FHIR DetectedIssue resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_DETECTEDISSUE(default RESOURCE_NAME_DETECTEDISSUE) - The type of the resource describes

meta BaseDetectedIssueMeta(default { profile : [PROFILE_BASE_DETECTEDISSUE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

severity DetectedIssueSeverity? - Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.

identifier Identifier[]? - Business identifier associated with the detected issue record.

extension Extension[]? - 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.

mitigation DetectedIssueMitigation[]? - Indicates an action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.

code CodeableConcept? - Identifies the general type of issue identified.

evidence DetectedIssueEvidence[]? - Supporting evidence or manifestations that provide the basis for identifying the detected issue such as a GuidanceResponse or MeasureReport.

author Reference? - Individual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

reference uri? - The literature, knowledge-base or similar reference that describes the propensity for the detected issue identified.

contained Resource[]? - 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.

patient Reference? - Indicates the patient whose record the detected issue is associated with.

identifiedDateTime dateTime? - The date or period when the detected issue was initially identified.

identifiedPeriod Period? - The date or period when the detected issue was initially identified.

implicated Reference[]? - Indicates the resource representing the current activity or proposed activity that is potentially problematic.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

detail string? - A textual explanation of the detected issue.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

status DetectedIssueStatus - Indicates the status of the detected issue.

never... - Rest field

health.fhir.r4: DetectedIssueEvidence

Closed record

FHIR DetectedIssueEvidence datatype record.

Fields

extension Extension[]? - 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.

code CodeableConcept[]? - A manifestation that led to the recording of this detected issue.

modifierExtension Extension[]? - 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).

detail Reference[]? - Links to resources that constitute evidence for the detected issue such as a GuidanceResponse or MeasureReport.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: DetectedIssueMitigation

Closed record

FHIR DetectedIssueMitigation datatype record.

Fields

date dateTime? - Indicates when the mitigating action was documented.

extension Extension[]? - 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.

author Reference? - Identifies the practitioner who determined the mitigation and takes responsibility for the mitigation step occurring.

modifierExtension Extension[]? - 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).

action CodeableConcept - Describes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified issue.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: Device

FHIR Device resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_DEVICE(default RESOURCE_NAME_DEVICE) - The type of the resource describes

meta BaseDeviceMeta(default { profile : [PROFILE_BASE_DEVICE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

note Annotation[]? - Descriptive information, usage information or implantation information that is not captured in an existing element.

parent Reference? - The parent device.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

distinctIdentifier string? - The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.

'type CodeableConcept? - The kind or type of device.

deviceName DeviceDeviceName[]? - This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.

manufacturer string? - A name of the manufacturer.

statusReason CodeableConcept[]? - Reason for the dtatus of the Device availability.

patient Reference? - Patient information, If the device is affixed to a person.

safety CodeableConcept[]? - Provides additional safety characteristics about a medical device. For example devices containing latex.

contact ContactPoint[]? - Contact details for an organization or a particular human that is responsible for the device.

property DeviceProperty[]? - The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.

manufactureDate dateTime? - The date and time when the device was manufactured.

definition Reference? - The reference to the definition for the device.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

expirationDate dateTime? - The date and time beyond which this device is no longer valid or should not be used (if applicable).

owner Reference? - An organization that is responsible for the provision and ongoing maintenance of the device.

identifier Identifier[]? - Unique instance identifiers assigned to a device by manufacturers other organizations or owners.

serialNumber string? - The serial number assigned by the organization when the device was manufactured.

lotNumber string? - Lot number assigned by the manufacturer.

'version DeviceVersion[]? - The actual design of the device or software version running on the device.

url uri? - A network address on which the device may be contacted directly.

contained Resource[]? - 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.

udiCarrier DeviceUdiCarrier[]? - Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

specialization DeviceSpecialization[]? - The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.

location Reference? - The place where the device can be found.

modelNumber string? - The model number for the device.

partNumber string? - The part number of the device.

status DeviceStatus? - Status of the Device availability.

never... - Rest field

health.fhir.r4: DeviceDefinition

FHIR DeviceDefinition resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_DEVICEDEFINITION(default RESOURCE_NAME_DEVICEDEFINITION) - The type of the resource describes

meta BaseDeviceDefinitionMeta(default { profile : [PROFILE_BASE_DEVICEDEFINITION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

note Annotation[]? - Descriptive information, usage information or implantation information that is not captured in an existing element.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

physicalCharacteristics ProdCharacteristic? - Dimensions, color etc.

language code? - The base language in which the resource is written.

'type CodeableConcept? - What kind of device or device system this is.

deviceName DeviceDefinitionDeviceName[]? - A name given to the device to identify it.

capability DeviceDefinitionCapability[]? - Device capabilities.

shelfLifeStorage ProductShelfLife[]? - Shelf Life and storage information.

safety CodeableConcept[]? - Safety characteristics of the device.

contact ContactPoint[]? - Contact details for an organization or a particular human that is responsible for the device.

parentDevice Reference? - The parent device it can be part of.

property DeviceDefinitionProperty[]? - The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.

onlineInformation uri? - Access to on-line information about the device.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

owner Reference? - An organization that is responsible for the provision and ongoing maintenance of the device.

identifier Identifier[]? - Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID.

manufacturerReference Reference? - A name of the manufacturer.

quantity Quantity? - The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product).

manufacturerString string? - A name of the manufacturer.

languageCode CodeableConcept[]? - Language code for the human-readable text strings produced by the device (all supported).

'version string[]? - The available versions of the device, e.g., software versions.

udiDeviceIdentifier DeviceDefinitionUdiDeviceIdentifier[]? - Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.

url uri? - A network address on which the device may be contacted directly.

contained Resource[]? - 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.

material DeviceDefinitionMaterial[]? - A substance used to create the material(s) of which the device is made.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

specialization DeviceDefinitionSpecialization[]? - The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.

modelNumber string? - The model number for the device.

never... - Rest field

health.fhir.r4: DeviceDefinitionCapability

Closed record

FHIR DeviceDefinitionCapability datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

description CodeableConcept[]? - Description of capability.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - Type of capability.

health.fhir.r4: DeviceDefinitionDeviceName

Closed record

FHIR DeviceDefinitionDeviceName datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

name string - The name of the device.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type DeviceDefinitionDeviceNameType - The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName.

health.fhir.r4: DeviceDefinitionMaterial

Closed record

FHIR DeviceDefinitionMaterial datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

substance CodeableConcept - The substance.

alternate boolean? - Indicates an alternative material of the device.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

allergenicIndicator boolean? - Whether the substance is a known or suspected allergen.

health.fhir.r4: DeviceDefinitionProperty

Closed record

FHIR DeviceDefinitionProperty datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

valueCode CodeableConcept[]? - Property value as a code, e.g., NTP4 (synced to NTP).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - Code that specifies the property DeviceDefinitionPropetyCode (Extensible).

valueQuantity Quantity[]? - Property value as a quantity.

health.fhir.r4: DeviceDefinitionSpecialization

Closed record

FHIR DeviceDefinitionSpecialization datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

systemType string - The standard that is used to operate and communicate.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version string? - The version of the standard that is used to operate and communicate.

health.fhir.r4: DeviceDefinitionUdiDeviceIdentifier

Closed record

FHIR DeviceDefinitionUdiDeviceIdentifier datatype record.

Fields

extension Extension[]? - 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.

deviceIdentifier string - The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier.

jurisdiction uri - The jurisdiction to which the deviceIdentifier applies.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

issuer uri - The organization that assigns the identifier algorithm.

health.fhir.r4: DeviceDeviceName

Closed record

FHIR DeviceDeviceName datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

name string - The name of the device.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type DeviceDeviceNameType - The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName.

health.fhir.r4: DeviceMetric

FHIR DeviceMetric resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_DEVICEMETRIC(default RESOURCE_NAME_DEVICEMETRIC) - The type of the resource describes

meta BaseDeviceMetricMeta(default { profile : [PROFILE_BASE_DEVICEMETRIC] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

operationalStatus DeviceMetricOperationalStatus? - Indicates current operational state of the device. For example: On, Off, Standby, etc.

identifier Identifier[]? - Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners. For example: handle ID.

parent Reference? - Describes the link to the Device that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device. An example would be a Device that represents a Channel. This reference can be used by a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location.

extension Extension[]? - 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.

measurementPeriod Timing? - Describes the measurement repetition time. This is not necessarily the same as the update period. The measurement repetition time can range from milliseconds up to hours. An example for a measurement repetition time in the range of milliseconds is the sampling rate of an ECG. An example for a measurement repetition time in the range of hours is a NIBP that is triggered automatically every hour. The update period may be different than the measurement repetition time, if the device does not update the published observed value with the same frequency as it was measured.

color DeviceMetricColor? - Describes the color representation for the metric. This is often used to aid clinicians to track and identify parameter types by color. In practice, consider a Patient Monitor that has ECG/HR and Pleth for example; the parameters are displayed in different characteristic colors, such as HR-blue, BP-green, and PR and SpO2- magenta.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

'source Reference? - Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.

'type CodeableConcept - Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.

contained Resource[]? - 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.

unit CodeableConcept? - Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

category DeviceMetricCategory - Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.

calibration DeviceMetricCalibration[]? - Describes the calibrations that have been performed or that are required to be performed.

never... - Rest field

health.fhir.r4: DeviceMetricCalibration

Closed record

FHIR DeviceMetricCalibration datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

state DeviceMetricCalibrationState? - Describes the state of the calibration.

time instant? - Describes the time last calibration has been performed.

'type DeviceMetricCalibrationType? - Describes the type of the calibration method.

health.fhir.r4: DeviceProperty

Closed record

FHIR DeviceProperty datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

valueCode CodeableConcept[]? - Property value as a code, e.g., NTP4 (synced to NTP).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - Code that specifies the property DeviceDefinitionPropetyCode (Extensible).

valueQuantity Quantity[]? - Property value as a quantity.

health.fhir.r4: DeviceRequest

FHIR DeviceRequest resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_DEVICEREQUEST(default RESOURCE_NAME_DEVICEREQUEST) - The type of the resource describes

meta BaseDeviceRequestMeta(default { profile : [PROFILE_BASE_DEVICEREQUEST] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

insurance Reference[]? - Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.

note Annotation[]? - Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.

extension Extension[]? - 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.

subject Reference - The patient who will use the device.

modifierExtension Extension[]? - 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).

reasonReference Reference[]? - Reason or justification for the use of this device.

language code? - The base language in which the resource is written.

priorRequest Reference[]? - The request takes the place of the referenced completed or terminated request(s).

instantiatesUri uri[]? - The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.

relevantHistory Reference[]? - Key events in the history of the request.

codeReference Reference - The details of the device to be used.

supportingInfo Reference[]? - Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body the device will be used (i.e. the target site).

'parameter DeviceRequestParameter[]? - Specific parameters for the ordered item. For example, the prism value for lenses.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

reasonCode CodeableConcept[]? - Reason or justification for the use of this device.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

basedOn Reference[]? - Plan/proposal/order fulfilled by this request.

requester Reference? - The individual who initiated the request and has responsibility for its activation.

identifier Identifier[]? - Identifiers assigned to this order by the orderer or by the receiver.

authoredOn dateTime? - When the request transitioned to being actionable.

performer Reference? - The desired performer for doing the diagnostic testing.

encounter Reference? - An encounter that provides additional context in which this request is made.

occurrenceTiming Timing? - The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. 'Every 8 hours'; 'Three times a day'; '1/2 an hour before breakfast for 10 days from 23-Dec 2011:'; '15 Oct 2013, 17 Oct 2013 and 1 Nov 2013'.

instantiatesCanonical canonical[]? - The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.

priority DeviceRequestPriority? - Indicates how quickly the {{title}} should be addressed with respect to other requests.

intent DeviceRequestIntent - Whether the request is a proposal, plan, an original order or a reflex order.

performerType CodeableConcept? - Desired type of performer for doing the diagnostic testing.

contained Resource[]? - 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.

occurrencePeriod Period? - The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. 'Every 8 hours'; 'Three times a day'; '1/2 an hour before breakfast for 10 days from 23-Dec 2011:'; '15 Oct 2013, 17 Oct 2013 and 1 Nov 2013'.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

occurrenceDateTime dateTime? - The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. 'Every 8 hours'; 'Three times a day'; '1/2 an hour before breakfast for 10 days from 23-Dec 2011:'; '15 Oct 2013, 17 Oct 2013 and 1 Nov 2013'.

groupIdentifier Identifier? - Composite request this is part of.

codeCodeableConcept CodeableConcept - The details of the device to be used.

status DeviceRequestStatus? - The status of the request.

never... - Rest field

health.fhir.r4: DeviceRequestParameter

Closed record

FHIR DeviceRequestParameter datatype record.

Fields

valueCodeableConcept CodeableConcept? - The value of the device detail.

valueBoolean boolean? - The value of the device detail.

extension Extension[]? - 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.

code CodeableConcept? - A code or string that identifies the device detail being asserted.

valueRange Range? - The value of the device detail.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueQuantity Quantity? - The value of the device detail.

health.fhir.r4: DeviceSpecialization

Closed record

FHIR DeviceSpecialization datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

systemType CodeableConcept - The standard that is used to operate and communicate.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version string? - The version of the standard that is used to operate and communicate.

health.fhir.r4: DeviceUdiCarrier

Closed record

FHIR DeviceUdiCarrier datatype record.

Fields

entryType DeviceUdiCarrierEntryType? - A coded entry to indicate how the data was entered.

extension Extension[]? - 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.

deviceIdentifier string? - The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.

carrierHRF string? - The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.

jurisdiction uri? - The identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/fda-udi.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

carrierAIDC base64Binary? - The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - e.g., a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats SHALL be base64 encoded.

issuer uri? - Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include : 1) GS1: http://hl7.org/fhir/NamingSystem/gs1-di, 2) HIBCC: http://hl7.org/fhir/NamingSystem/hibcc-dI, 3) ICCBBA for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood-di, 4) ICCBA for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other-di.

health.fhir.r4: DeviceUseStatement

FHIR DeviceUseStatement resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_DEVICEUSESTATEMENT(default RESOURCE_NAME_DEVICEUSESTATEMENT) - The type of the resource describes

meta BaseDeviceUseStatementMeta(default { profile : [PROFILE_BASE_DEVICEUSESTATEMENT] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

identifier Identifier[]? - An external identifier for this statement such as an IRI.

note Annotation[]? - Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.

extension Extension[]? - 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.

timingTiming Timing? - How often the device was used.

timingPeriod Period? - How often the device was used.

subject Reference - The patient who used the device.

modifierExtension Extension[]? - 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).

reasonReference Reference[]? - Indicates another resource whose existence justifies this DeviceUseStatement.

language code? - The base language in which the resource is written.

'source Reference? - Who reported the device was being used by the patient.

bodySite CodeableConcept? - Indicates the anotomic location on the subject's body where the device was used ( i.e. the target).

contained Resource[]? - 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.

derivedFrom Reference[]? - Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

recordedOn dateTime? - The time at which the statement was made/recorded.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

reasonCode CodeableConcept[]? - Reason or justification for the use of the device.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

device Reference - The details of the device used.

basedOn Reference[]? - A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement.

status DeviceUseStatementStatus - A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed.

timingDateTime dateTime? - How often the device was used.

never... - Rest field

health.fhir.r4: DeviceVersion

Closed record

FHIR DeviceVersion datatype record.

Fields

component Identifier? - A single component of the device version.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept? - The type of the device version.

value string - The version text.

health.fhir.r4: DiagnosticReport

FHIR DiagnosticReport resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_DIAGNOSTICREPORT(default RESOURCE_NAME_DIAGNOSTICREPORT) - The type of the resource describes

meta BaseDiagnosticReportMeta(default { profile : [PROFILE_BASE_DIAGNOSTICREPORT] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

extension Extension[]? - 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.

code CodeableConcept - A code or name that describes this diagnostic report.

subject Reference? - The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.

modifierExtension Extension[]? - 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).

presentedForm Attachment[]? - Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.

language code? - The base language in which the resource is written.

media DiagnosticReportMedia[]? - A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).

conclusion string? - Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.

result Reference[]? - Observations that are part of this diagnostic report.

specimen Reference[]? - Details about the specimens on which this diagnostic report is based.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified.

basedOn Reference[]? - Details concerning a service requested.

identifier Identifier[]? - Identifiers assigned to this report by the performer or other systems.

performer Reference[]? - The diagnostic service that is responsible for issuing the report.

effectivePeriod Period? - The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.

resultsInterpreter Reference[]? - The practitioner or organization that is responsible for the report's conclusions and interpretations.

conclusionCode CodeableConcept[]? - One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.

contained Resource[]? - 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.

effectiveDateTime dateTime? - The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[]? - A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.

imagingStudy Reference[]? - One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.

status DiagnosticReportStatus - The status of the diagnostic report.

never... - Rest field

health.fhir.r4: DiagnosticReportMedia

Closed record

FHIR DiagnosticReportMedia datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

link Reference - Reference to the image source.

comment string? - A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: Distance

Closed record

Fields

Fields Included from *Quantity

id string
extension Extension[]
value decimal
comparator QuantityComparatorCode
unit string
system uri
code code
Element...

id string? -

extension Extension[]? -

distanceValue decimal? -

unit string? -

system uri? -

code code? -

health.fhir.r4: DistanceExtension

Closed record

Fields

url uri -

valueDistance Distance -

health.fhir.r4: DocumentManifest

FHIR DocumentManifest resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_DOCUMENTMANIFEST(default RESOURCE_NAME_DOCUMENTMANIFEST) - The type of the resource describes

meta BaseDocumentManifestMeta(default { profile : [PROFILE_BASE_DOCUMENTMANIFEST] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

identifier Identifier[]? - Other identifiers associated with the document manifest, including version independent identifiers.

extension Extension[]? - 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.

author Reference[]? - Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.

created dateTime? - When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.).

subject Reference? - Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).

modifierExtension Extension[]? - 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).

description string? - Human-readable description of the source document. This is sometimes known as the 'title'.

language code? - The base language in which the resource is written.

'source uri? - Identifies the source system, application, or software that produced the document manifest.

masterIdentifier Identifier? - A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.

'type CodeableConcept? - The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.

content Reference[] - The list of Resources that consist of the parts of this manifest.

contained Resource[]? - 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.

recipient Reference[]? - A patient, practitioner, or organization for which this set of documents is intended.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

status DocumentManifestStatus - The status of this document manifest.

never... - Rest field

health.fhir.r4: DocumentManifestRelated

Closed record

FHIR DocumentManifestRelated datatype record.

Fields

identifier Identifier? - Related identifier to this DocumentManifest. For example, Order numbers, accession numbers, XDW workflow numbers.

extension Extension[]? - 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.

ref Reference? - Related Resource to this DocumentManifest. For example, Order, ServiceRequest, Procedure, EligibilityRequest, etc.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: DocumentReference

FHIR DocumentReference resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_DOCUMENTREFERENCE(default RESOURCE_NAME_DOCUMENTREFERENCE) - The type of the resource describes

meta BaseDocumentReferenceMeta(default { profile : [PROFILE_BASE_DOCUMENTREFERENCE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date instant? - When the document reference was created.

identifier Identifier[]? - Other identifiers associated with the document, including version independent identifiers.

extension Extension[]? - 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.

custodian Reference? - Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.

author Reference[]? - Identifies who is responsible for adding the information to the document.

securityLabel CodeableConcept[]? - A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the 'reference' to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.

subject Reference? - Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).

modifierExtension Extension[]? - 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).

description string? - Human-readable description of the source document.

language code? - The base language in which the resource is written.

masterIdentifier Identifier? - Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.

'type CodeableConcept? - Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.

content DocumentReferenceContent[] - The document and format referenced. There may be multiple content element repetitions, each with a different format.

contained Resource[]? - 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.

docStatus DocumentReferenceDocStatus? - The status of the underlying document.

context DocumentReferenceContext? - The clinical context in which the document was prepared.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

category CodeableConcept[]? - A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.

relatesTo DocumentReferenceRelatesTo[]? - Relationships that this document has with other document references that already exist.

authenticator Reference? - Which person or organization authenticates that this document is valid.

status DocumentReferenceStatus - The status of this document reference.

never... - Rest field

health.fhir.r4: DocumentReferenceContent

Closed record

FHIR DocumentReferenceContent datatype record.

Fields

extension Extension[]? - 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.

attachment Attachment - The document or URL of the document along with critical metadata to prove content has integrity.

modifierExtension Extension[]? - 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).

format Coding? - An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: DocumentReferenceContext

Closed record

FHIR DocumentReferenceContext datatype record.

Fields

extension Extension[]? - 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.

period Period? - The time period over which the service that is described by the document was provided.

facilityType CodeableConcept? - The kind of facility where the patient was seen.

practiceSetting CodeableConcept? - This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.

modifierExtension Extension[]? - 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).

encounter Reference[]? - Describes the clinical encounter or type of care that the document content is associated with.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

event CodeableConcept[]? - This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a 'History and Physical Report' in which the procedure being documented is necessarily a 'History and Physical' act.

sourcePatientInfo Reference? - The Patient Information as known when the document was published. May be a reference to a version specific, or contained.

health.fhir.r4: DocumentReferenceRelatesTo

Closed record

FHIR DocumentReferenceRelatesTo datatype record.

Fields

extension Extension[]? - 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.

code DocumentReferenceRelatesToCode - The type of relationship that this document has with anther document.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

target Reference - The target document of this relationship.

health.fhir.r4: DomainResource

A resource with narrative, extensions, and contained resources.

Rule: If the resource is contained in another resource, it SHALL NOT contain nested Resources.
Rule: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
Rule: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated.
Rule: If a resource is contained in another resource, it SHALL NOT have a security label.
Guideline: A resource should have narrative for robust management.

Fields

Fields Included from *Resource

resourceType string
id string
meta Meta
implicitRules uri
language code

text Narrative? - Text summary of the resource, for human interpretation

contained Resource[]? - Contained, inline Resources

extension Extension[]? - Additional content defined by implementations

modifierExtension Extension[]? - Extensions that cannot be ignored

health.fhir.r4: Dosage

Closed record

How the medication is/was taken or should be taken.

Fields

Fields Included from *BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

modifierExtension Extension[]? - Extensions that cannot be ignored even if unrecognized

sequence integer? - The order of the dosage instructions

text string? - Free text dosage instructions e.g. SIG

addtionalInstruction CodeableConcept[]? - Supplemental instruction or warnings to the patient - e.g. with meals,may cause drowsiness

patientInstruction string? - Patient or consumer oriented instructions

timing Timing? - When medication should be administered

asNeededBoolean boolean? - Take as needed

asNeededCodeableConcept boolean? - Take as needed

site CodeableConcept? - Body site to administer to

route CodeableConcept? - How drug should enter body

method CodeableConcept? - Technique for administering medication

doseAndRate ElementDoseAndRate[]? - Amount of medication administered

maxDosePerPeriod Ratio? - Upper limit on medication per unit of time

maxDosePerAdministration SimpleQuantity? - Upper limit on medication per administration

maxDosePerLifetime SimpleQuantity? - Upper limit on medication per lifetime of the patient

health.fhir.r4: DosageExtension

Closed record

Fields

url uri -

valueDosage Dosage -

health.fhir.r4: Duration

Closed record

Fields

Fields Included from *Quantity

id string
extension Extension[]
value decimal
comparator QuantityComparatorCode
unit string
system uri
code code
Element...

id string? -

extension Extension[]? -

durationValue decimal? -

unit string? -

system uri? -

code code? -

health.fhir.r4: DurationExtension

Closed record

Fields

url uri -

valueDuration Duration -

health.fhir.r4: EffectEvidenceSynthesis

FHIR EffectEvidenceSynthesis resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_EFFECTEVIDENCESYNTHESIS(default RESOURCE_NAME_EFFECTEVIDENCESYNTHESIS) - The type of the resource describes

meta BaseEffectEvidenceSynthesisMeta(default { profile : [PROFILE_BASE_EFFECTEVIDENCESYNTHESIS] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime? - The date (and optionally time) when the effect evidence synthesis was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the effect evidence synthesis changes.

note Annotation[]? - A human-readable string to clarify or explain concepts about the resource.

copyright markdown? - A copyright statement relating to the effect evidence synthesis and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the effect evidence synthesis.

extension Extension[]? - 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.

approvalDate date? - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

jurisdiction CodeableConcept[]? - A legal or geographic region in which the effect evidence synthesis is intended to be used.

modifierExtension Extension[]? - 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).

description markdown? - A free text natural language description of the effect evidence synthesis from a consumer's perspective.

language code? - The base language in which the resource is written.

sampleSize EffectEvidenceSynthesisSampleSize? - A description of the size of the sample involved in the synthesis.

title string? - A short, descriptive, user-friendly title for the effect evidence synthesis.

exposureAlternative Reference - A reference to a EvidenceVariable resource that defines the comparison exposure for the research.

studyType CodeableConcept? - Type of study eg randomized trial.

contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.

endorser ContactDetail[]? - An individual or organization responsible for officially endorsing the content for use in some setting.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

outcome Reference - A reference to a EvidenceVariable resomece that defines the outcome for the research.

editor ContactDetail[]? - An individual or organization primarily responsible for internal coherence of the content.

identifier Identifier[]? - A formal identifier that is used to identify this effect evidence synthesis when it is represented in other formats, or referenced in a specification, model, design or an instance.

resultsByExposure EffectEvidenceSynthesisResultsByExposure[]? - A description of the results for each exposure considered in the effect estimate.

relatedArtifact RelatedArtifact[]? - Related artifacts such as additional documentation, justification, or bibliographic references.

effectivePeriod Period? - The period during which the effect evidence synthesis content was or is planned to be in active use.

author ContactDetail[]? - An individiual or organization primarily involved in the creation and maintenance of the content.

certainty EffectEvidenceSynthesisCertainty[]? - A description of the certainty of the effect estimate.

reviewer ContactDetail[]? - An individual or organization primarily responsible for review of some aspect of the content.

'version string? - The identifier that is used to identify this version of the effect evidence synthesis when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the effect evidence synthesis author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

url uri? - An absolute URI that is used to identify this effect evidence synthesis when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this effect evidence synthesis is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the effect evidence synthesis is stored on different servers.

population Reference - A reference to a EvidenceVariable resource that defines the population for the research.

contained Resource[]? - 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.

effectEstimate EffectEvidenceSynthesisEffectEstimate[]? - The estimated effect of the exposure variant.

exposure Reference - A reference to a EvidenceVariable resource that defines the exposure for the research.

lastReviewDate date? - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

synthesisType CodeableConcept? - Type of synthesis eg meta-analysis.

name string? - A natural language name identifying the effect evidence synthesis. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher string? - The name of the organization or individual that published the effect evidence synthesis.

topic CodeableConcept[]? - Descriptive topics related to the content of the EffectEvidenceSynthesis. Topics provide a high-level categorization grouping types of EffectEvidenceSynthesiss that can be useful for filtering and searching.

useContext UsageContext[]? - 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 effect evidence synthesis instances.

status EffectEvidenceSynthesisStatus - The status of this effect evidence synthesis. Enables tracking the life-cycle of the content.

never... - Rest field

health.fhir.r4: EffectEvidenceSynthesisCertainty

Closed record

FHIR EffectEvidenceSynthesisCertainty datatype record.

Fields

note Annotation[]? - A human-readable string to clarify or explain concepts about the resource.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

rating CodeableConcept[]? - A rating of the certainty of the effect estimate.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

certaintySubcomponent EffectEvidenceSynthesisCertaintyCertaintySubcomponent[]? - A description of a component of the overall certainty.

health.fhir.r4: EffectEvidenceSynthesisCertaintyCertaintySubcomponent

Closed record

FHIR EffectEvidenceSynthesisCertaintyCertaintySubcomponent datatype record.

Fields

note Annotation[]? - A human-readable string to clarify or explain concepts about the resource.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

rating CodeableConcept[]? - A rating of a subcomponent of rating certainty.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept? - Type of subcomponent of certainty rating.

health.fhir.r4: EffectEvidenceSynthesisEffectEstimate

Closed record

FHIR EffectEvidenceSynthesisEffectEstimate datatype record.

Fields

extension Extension[]? - 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.

unitOfMeasure CodeableConcept? - Specifies the UCUM unit for the outcome.

variantState CodeableConcept? - Used to define variant exposure states such as low-risk state.

modifierExtension Extension[]? - 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).

precisionEstimate EffectEvidenceSynthesisEffectEstimatePrecisionEstimate[]? - A description of the precision of the estimate for the effect.

description string? - Human-readable summary of effect estimate.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept? - Examples include relative risk and mean difference.

value decimal? - The point estimate of the effect estimate.

health.fhir.r4: EffectEvidenceSynthesisEffectEstimatePrecisionEstimate

Closed record

FHIR EffectEvidenceSynthesisEffectEstimatePrecisionEstimate datatype record.

Fields

extension Extension[]? - 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.

level decimal? - Use 95 for a 95% confidence interval.

modifierExtension Extension[]? - 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).

'from decimal? - Lower bound of confidence interval.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

to decimal? - Upper bound of confidence interval.

'type CodeableConcept? - Examples include confidence interval and interquartile range.

health.fhir.r4: EffectEvidenceSynthesisResultsByExposure

Closed record

FHIR EffectEvidenceSynthesisResultsByExposure datatype record.

Fields

extension Extension[]? - 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.

variantState CodeableConcept? - Used to define variant exposure states such as low-risk state.

exposureState EffectEvidenceSynthesisResultsByExposureExposureState? - Whether these results are for the exposure state or alternative exposure state.

modifierExtension Extension[]? - 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).

description string? - Human-readable summary of results by exposure state.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

riskEvidenceSynthesis Reference - Reference to a RiskEvidenceSynthesis resource.

health.fhir.r4: EffectEvidenceSynthesisSampleSize

Closed record

FHIR EffectEvidenceSynthesisSampleSize datatype record.

Fields

numberOfParticipants integer? - Number of participants included in this evidence synthesis.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

description string? - Human-readable summary of sample size.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

numberOfStudies integer? - Number of studies included in this evidence synthesis.

health.fhir.r4: Element

The base definition for all elements contained inside a resource.

Fields

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

Element... - Rest field

health.fhir.r4: ElementAnnotationDefinition

Element definition.

Fields

name string - Name of the element

dataType typedesc - Data type of the element

min int - Minimum Cardinality

max int - Maximum Cardinality (a number or *). In ballerina * is represented by maximum int value

isArray boolean - Is this element holds array (is cardinality > 1)

description string? - Description of the elemenet

path string? - FHIR path pf the element respective to the parent

valueSet string? - If coded values are bound to a ValueSet

mustSupport boolean? - The following data-elements are mandatory (i.e data MUST be present) or must be supported if the data is present in the sending system

health.fhir.r4: ElementBase

Closed record

Base definition information for tools.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

path string - Path that identifies the base element

min unsignedInt - Min cardinality of the base element

max string - Max cardinality of the base element

health.fhir.r4: ElementBinding

Closed record

ValueSet details if this is coded.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

strength StrengthCode - required | extensible | preferred | example

description string? - Human explanation of the value set

valueSet canonical? - Source of value set

health.fhir.r4: ElementCodeFilter

Closed record

What codes are expected.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

path string? - A code-valued attribute to filter on

searchParam string? - A coded (token) parameter to search on

valueSet canonical? - Valueset for the filter

code Coding[]? - What code is expected

health.fhir.r4: ElementConstraint

Closed record

Condition that must evaluate to true.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

key id - Target of 'condition' reference above

requirements string? - Why this constraint is necessary or appropriate

severity string - error | warning

human string - Human description of constraint

expression string? - FHIRPath expression of constraint

xpath string? - XPath expression of constraint

'source canonical? - Reference to original source of constraint

health.fhir.r4: ElementDateFilter

Closed record

What dates/date ranges are expected.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

path string? - A date-valued attribute to filter on

searchParam string? - A date valued parameter to search on

valueDateTime dateTime? - The value of the filter, as a DateTime

valuePeriod Period? - The value of the filter, as a Period

valueDuration Duration? - The value of the filter, as a Duration value

health.fhir.r4: ElementDefinition

Closed record

Definition of an element in a resource or extension.

Fields

Fields Included from *BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

modifierExtension Extension[]? - Additional content defined by implementations

path string - Path of the element in the hierarchy of elements

representation code[]? - xmlAttr | xmlText | typeAttr | cdaText | xhtml

sliceName string? - Name for this particular element (in a set of slices)

sliceIsConstraining boolean? - If this slice definition constrains an inherited slice definition (or not)

label string? - Name for element to display with or prompt for element

code Coding[]? - Corresponding codes in terminologies

slicing ElementSlicing? - This element is sliced - slices follow

short string? - Concise definition for space-constrained presentation

definition markdown? - Full formal definition as narrative text

comment markdown? - Comments about the use of this element

requirements markdown? - Why this resource has been created

alias string[]? - Other names

min unsignedInt? - Minimum Cardinality

max string? - Maximum Cardinality

base ElementBase? - Base definition information for tools

contendReference uri? - Reference to definition of content for the element

'type ElementType[]? - Data type and Profile for this element

defaultValue Element? - Specified value if missing from instance

meaningWhenMissing markdown? - Implicit meaning when this element is missing

orderMeaning string? - What the order of the elements means

fixed Element? - Value must be exactly this

pattern Element? - Value must have at least these property values

example ElementExample[]? - Example value (as defined for type)

minValueDate date? - Minimum Allowed Value for date

minValueDateTime dateTime? - Minimum Allowed Value for datetime

minValueInstant instant? - Minimum Allowed Value for instant

minValueTime time? - Minimum Allowed Value for time

minValueDecimal decimal? - Minimum Allowed Value for decimal

minValueInteger integer? - Minimum Allowed Value for integer

minValuePositiveInt positiveInt? - Minimum Allowed Value for positiveint

minValueUnsignedInt unsignedInt? - Minimum Allowed Value for unsignedint

minValueQuantity Quantity? - Minimum Allowed Value for quantity

maxValueDate date? - Maximum Allowed Value for date

maxValueDateTime dateTime? - Maximum Allowed Value for datetime

maxValueInstant instant? - Maximum Allowed Value for instant

maxValueTime time? - Maximum Allowed Value for time

maxValueDecimal decimal? - Maximum Allowed Value for decimal

maxValueInteger integer? - Maximum Allowed Value for integer

maxValuePositiveInt positiveInt? - Maximum Allowed Value for positiveint

maxValueUnsignedInt unsignedInt? - Maximum Allowed Value for unsignedint

maxValueQuantity Quantity? - Maximum Allowed Value for quantity

maxLength integer? - Maximum Allowed Value for length

condition id[]? - Reference to invariant about presence

constraint ElementConstraint[]? - Condition that must evaluate to true

mustSupport boolean? - If the element must be supported

isModifier boolean? - If this modifies the meaning of other elements

isModifierReason string? - Reason that this element is marked as a modifier

isSummary boolean? - Include when _summary = true?

binding ElementBinding? - ValueSet details if this is coded

mapping ElementMapping[]? - Map element to another set of definitions

health.fhir.r4: ElementDiscriminator

Closed record

Element values that are used to distinguish the slices.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

'type ElementDiscriminatorType - value | exists | pattern | type | profile

path string - Path to element value

health.fhir.r4: ElementDoseAndRate

Closed record

Amount of medication administered.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

'type CodeableConcept? - The kind of dose or rate specified

doseRange Range? - Amount of medication per dose

doseQuantity SimpleQuantity? - Amount of medication per dose

rateRatio Ratio? - Amount of medication per unit of time

rateRange Range? - Amount of medication per unit of time

rateQuantity SimpleQuantity? - Amount of medication per unit of time

health.fhir.r4: ElementExample

Closed record

Example value (as defined for type).

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

label string - Describes the purpose of this example

value Element - Value of Example (one of allowed types)

health.fhir.r4: ElementMapping

Closed record

Map element to another set of definitions.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

identity id - Reference to mapping declaration

language code? - Computable language of mapping

'map string - Details of the mapping

comment string? - Comments about the mapping or its use

health.fhir.r4: ElementRepeat

When the event is to occur.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

boundsDuration Duration? - (Start and/or end) limits

boundsRange Range? - Range of lengths

boundsPeriod Period? - Range of lengths, or (Start and/or end) limits

count positiveInt? - Number of times to repeat

countMax positiveInt? - Maximum number of times to repeat

duration decimal? - How long when it happens

durationMax decimal? - How long when it happens (Max)

durationUnit Timecode? - Funit of time (UCUM) UnitsOfTime (Required)

frequency positiveInt? - Event occurs frequency times per period

frequencyMax positiveInt? - Event occurs up to frequencyMax times per period

period decimal? - Event occurs frequency times per period

periodMax decimal? - Upper limit of period (3-4 hours)

periodUnit Timecode? - unit of time (UCUM)UnitsOfTime (Required)

dayOfWeek Daycode[]? - DaysOfWeek (Required)

timeOfDay time[]? - Time of day for action

when code[]? - Code for time period of occurrence EventTiming (Required)

offset unsignedInt? - Minutes from event (before or after)

health.fhir.r4: ElementSlicing

Closed record

This element is sliced - slices follow.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

discriminator ElementDiscriminator[]? - Element values that are used to distinguish the slices

description string? - Text description of how slicing works (or not)

ordered boolean? - If elements must be in same order as slices

rules ElementSlicingRules - closed | open | openAtEnd

health.fhir.r4: ElementSort

Closed record

Order of the results.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

path string - The name of the attribute to perform the sort

direction DirectionCode - ascending | descending

health.fhir.r4: ElementType

Closed record

Data type and Profile for this element.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

code uri - Data type or Resource (reference to definition)

profile canonical[]? - Profiles (StructureDefinition or IG) - one must apply

targetProfile canonical[]? - Profile (StructureDefinition or IG) on the Reference/canonical target - one must apply

aggregation TypeAggregation[]? - contained | referenced | bundled - how aggregated

versioning TypeVersioning? - either | independent | specific

health.fhir.r4: Encounter

FHIR Encounter resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_ENCOUNTER(default RESOURCE_NAME_ENCOUNTER) - The type of the resource describes

meta BaseEncounterMeta(default { profile : [PROFILE_BASE_ENCOUNTER] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

serviceType CodeableConcept? - Broad categorization of the service that is to be provided (e.g. cardiology).

partOf Reference? - Another Encounter of which this encounter is a part of (administratively or in time).

extension Extension[]? - 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.

subject Reference? - The patient or group present at the encounter.

modifierExtension Extension[]? - 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).

reasonReference Reference[]? - Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.

appointment Reference[]? - The appointment that scheduled this encounter.

language code? - The base language in which the resource is written.

'type CodeableConcept[]? - Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).

participant EncounterParticipant[]? - The list of people responsible for providing the service.

episodeOfCare Reference[]? - Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

reasonCode CodeableConcept[]? - Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

'class Coding - Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.

basedOn Reference[]? - The request this encounter satisfies (e.g. incoming referral or procedure request).

identifier Identifier[]? - Identifier(s) by which this encounter is known.

period Period? - The start and end time of the encounter.

classHistory EncounterClassHistory[]? - The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient.

hospitalization EncounterHospitalization? - Details about the admission to a healthcare service.

length Duration? - Quantity of time the encounter lasted. This excludes the time during leaves of absence.

diagnosis EncounterDiagnosis[]? - The list of diagnosis relevant to this encounter.

priority CodeableConcept? - Indicates the urgency of the encounter.

contained Resource[]? - 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.

statusHistory EncounterStatusHistory[]? - The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.

serviceProvider Reference? - The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

location EncounterLocation[]? - List of locations where the patient has been during this encounter.

account Reference[]? - The set of accounts that may be used for billing for this Encounter.

status EncounterStatus - planned | arrived | triaged | in-progress | onleave | finished | cancelled +.

never... - Rest field

health.fhir.r4: EncounterClassHistory

Closed record

FHIR EncounterClassHistory datatype record.

Fields

extension Extension[]? - 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.

period Period - The time that the episode was in the specified class.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'class Coding - inpatient | outpatient | ambulatory | emergency +.

health.fhir.r4: EncounterDiagnosis

Closed record

FHIR EncounterDiagnosis datatype record.

Fields

condition Reference - Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.

extension Extension[]? - 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.

use CodeableConcept? - Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …).

modifierExtension Extension[]? - 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).

rank positiveInt? - Ranking of the diagnosis (for each role type).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: EncounterHospitalization

Closed record

FHIR EncounterHospitalization datatype record.

Fields

extension Extension[]? - 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.

specialArrangement CodeableConcept[]? - Any special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things.

reAdmission CodeableConcept? - Whether this hospitalization is a readmission and why if known.

modifierExtension Extension[]? - 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).

origin Reference? - The location/organization from which the patient came before admission.

destination Reference? - Location/organization to which the patient is discharged.

dietPreference CodeableConcept[]? - Diet preferences reported by the patient.

preAdmissionIdentifier Identifier? - Pre-admission identifier.

specialCourtesy CodeableConcept[]? - Special courtesies (VIP, board member).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

dischargeDisposition CodeableConcept? - Category or kind of location after discharge.

admitSource CodeableConcept? - From where patient was admitted (physician referral, transfer).

health.fhir.r4: EncounterLocation

Closed record

FHIR EncounterLocation datatype record.

Fields

extension Extension[]? - 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.

period Period? - Time period during which the patient was present at the location.

modifierExtension Extension[]? - 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).

physicalType CodeableConcept? - This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query.

location Reference - The location where the encounter takes place.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

status EncounterLocationStatus? - The status of the participants' presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time.

health.fhir.r4: EncounterParticipant

Closed record

FHIR EncounterParticipant datatype record.

Fields

extension Extension[]? - 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.

period Period? - The period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period.

individual Reference? - Persons involved in the encounter other than the patient.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept[]? - Role of participant in encounter.

health.fhir.r4: EncounterStatusHistory

Closed record

FHIR EncounterStatusHistory datatype record.

Fields

extension Extension[]? - 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.

period Period - The time that the episode was in the specified status.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

status EncounterStatusHistoryStatus - planned | arrived | triaged | in-progress | onleave | finished | cancelled +.

health.fhir.r4: Endpoint

FHIR Endpoint resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_ENDPOINT(default RESOURCE_NAME_ENDPOINT) - The type of the resource describes

meta BaseEndpointMeta(default { profile : [PROFILE_BASE_ENDPOINT] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

identifier Identifier[]? - Identifier for the organization that is used to identify the endpoint across multiple disparate systems.

extension Extension[]? - 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.

period Period? - The interval during which the endpoint is expected to be operational.

address urlType - The uri that describes the actual end-point to connect to.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

connectionType Coding - A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).

contained Resource[]? - 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.

managingOrganization Reference? - The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data).

payloadType CodeableConcept[] - The payload type describes the acceptable content that can be communicated on the endpoint.

contact ContactPoint[]? - Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.

name string? - A friendly name that this endpoint can be referred to with.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

payloadMimeType code[]? - The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).

status EndpointStatus - active | suspended | error | off | test.

never... - Rest field

health.fhir.r4: EnrollmentRequest

FHIR EnrollmentRequest resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_ENROLLMENTREQUEST(default RESOURCE_NAME_ENROLLMENTREQUEST) - The type of the resource describes

meta BaseEnrollmentRequestMeta(default { profile : [PROFILE_BASE_ENROLLMENTREQUEST] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

coverage Reference? - Reference to the program or plan identification, underwriter or payor.

identifier Identifier[]? - The Response business identifier.

extension Extension[]? - 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.

created dateTime? - The date when this resource was created.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

candidate Reference? - Patient Resource.

contained Resource[]? - 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.

provider Reference? - The practitioner who is responsible for the services rendered to the patient.

insurer Reference? - The Insurer who is target of the request.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

status EnrollmentRequestStatus? - The status of the resource instance.

never... - Rest field

health.fhir.r4: EnrollmentResponse

FHIR EnrollmentResponse resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_ENROLLMENTRESPONSE(default RESOURCE_NAME_ENROLLMENTRESPONSE) - The type of the resource describes

meta BaseEnrollmentResponseMeta(default { profile : [PROFILE_BASE_ENROLLMENTRESPONSE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

identifier Identifier[]? - The Response business identifier.

request Reference? - Original request resource reference.

extension Extension[]? - 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.

created dateTime? - The date when the enclosed suite of services were performed or completed.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

contained Resource[]? - 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.

disposition string? - A description of the status of the adjudication.

requestProvider Reference? - The practitioner who is responsible for the services rendered to the patient.

organization Reference? - The Insurer who produced this adjudicated response.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

outcome EnrollmentResponseOutcome? - Processing status: error, complete.

status EnrollmentResponseStatus? - The status of the resource instance.

never... - Rest field

health.fhir.r4: EpisodeOfCare

FHIR EpisodeOfCare resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_EPISODEOFCARE(default RESOURCE_NAME_EPISODEOFCARE) - The type of the resource describes

meta BaseEpisodeOfCareMeta(default { profile : [PROFILE_BASE_EPISODEOFCARE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

identifier Identifier[]? - The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes.

extension Extension[]? - 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.

period Period? - The interval during which the managing organization assumes the defined responsibility.

modifierExtension Extension[]? - 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).

diagnosis EpisodeOfCareDiagnosis[]? - The list of diagnosis relevant to this episode of care.

careManager Reference? - The practitioner that is the care manager/care coordinator for this patient.

language code? - The base language in which the resource is written.

team Reference[]? - The list of practitioners that may be facilitating this episode of care for specific purposes.

'type CodeableConcept[]? - A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care.

contained Resource[]? - 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.

statusHistory EpisodeOfCareStatusHistory[]? - The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).

managingOrganization Reference? - The organization that has assumed the specific responsibilities for the specified duration.

referralRequest Reference[]? - Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.

patient Reference - The patient who is the focus of this episode of care.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

account Reference[]? - The set of accounts that may be used for billing for this EpisodeOfCare.

status EpisodeOfCareStatus - planned | waitlist | active | onhold | finished | cancelled.

never... - Rest field

health.fhir.r4: EpisodeOfCareDiagnosis

Closed record

FHIR EpisodeOfCareDiagnosis datatype record.

Fields

condition Reference - A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for.

extension Extension[]? - 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.

role CodeableConcept? - Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …).

modifierExtension Extension[]? - 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).

rank positiveInt? - Ranking of the diagnosis (for each role type).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: EpisodeOfCareStatusHistory

Closed record

FHIR EpisodeOfCareStatusHistory datatype record.

Fields

extension Extension[]? - 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.

period Period - The period during this EpisodeOfCare that the specific status applied.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

status EpisodeOfCareStatusHistoryStatus - planned | waitlist | active | onhold | finished | cancelled.

health.fhir.r4: EventDefinition

FHIR EventDefinition resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_EVENTDEFINITION(default RESOURCE_NAME_EVENTDEFINITION) - The type of the resource describes

meta BaseEventDefinitionMeta(default { profile : [PROFILE_BASE_EVENTDEFINITION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime? - The date (and optionally time) when the event definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the event definition changes.

copyright markdown? - A copyright statement relating to the event definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the event definition.

extension Extension[]? - 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.

approvalDate date? - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

subjectCodeableConcept CodeableConcept? - A code or group definition that describes the intended subject of the event definition.

purpose markdown? - Explanation of why this event definition is needed and why it has been designed as it has.

jurisdiction CodeableConcept[]? - A legal or geographic region in which the event definition is intended to be used.

modifierExtension Extension[]? - 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).

usage string? - A detailed description of how the event definition is used from a clinical perspective.

description markdown? - A free text natural language description of the event definition from a consumer's perspective.

experimental boolean? - A Boolean value to indicate that this event definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language code? - The base language in which the resource is written.

title string? - A short, descriptive, user-friendly title for the event definition.

contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.

endorser ContactDetail[]? - An individual or organization responsible for officially endorsing the content for use in some setting.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

editor ContactDetail[]? - An individual or organization primarily responsible for internal coherence of the content.

identifier Identifier[]? - A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

relatedArtifact RelatedArtifact[]? - Related resources such as additional documentation, justification, or bibliographic references.

effectivePeriod Period? - The period during which the event definition content was or is planned to be in active use.

author ContactDetail[]? - An individiual or organization primarily involved in the creation and maintenance of the content.

reviewer ContactDetail[]? - An individual or organization primarily responsible for review of some aspect of the content.

trigger TriggerDefinition[] - The trigger element defines when the event occurs. If more than one trigger condition is specified, the event fires whenever any one of the trigger conditions is met.

subjectReference Reference? - A code or group definition that describes the intended subject of the event definition.

'version string? - The identifier that is used to identify this version of the event definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the event definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

url uri? - An absolute URI that is used to identify this event definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this event definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the event definition is stored on different servers.

contained Resource[]? - 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.

lastReviewDate date? - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

subtitle string? - An explanatory or alternate title for the event definition giving additional information about its content.

name string? - A natural language name identifying the event definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher string? - The name of the organization or individual that published the event definition.

topic CodeableConcept[]? - Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.

useContext UsageContext[]? - 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 event definition instances.

status EventDefinitionStatus - The status of this event definition. Enables tracking the life-cycle of the content.

never... - Rest field

health.fhir.r4: Evidence

FHIR Evidence resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_EVIDENCE(default RESOURCE_NAME_EVIDENCE) - The type of the resource describes

meta BaseEvidenceMeta(default { profile : [PROFILE_BASE_EVIDENCE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime? - The date (and optionally time) when the evidence was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the evidence changes.

note Annotation[]? - A human-readable string to clarify or explain concepts about the resource.

copyright markdown? - A copyright statement relating to the evidence and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the evidence.

extension Extension[]? - 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.

approvalDate date? - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

jurisdiction CodeableConcept[]? - A legal or geographic region in which the evidence is intended to be used.

modifierExtension Extension[]? - 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).

description markdown? - A free text natural language description of the evidence from a consumer's perspective.

language code? - The base language in which the resource is written.

shortTitle string? - The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.

title string? - A short, descriptive, user-friendly title for the evidence.

contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.

endorser ContactDetail[]? - An individual or organization responsible for officially endorsing the content for use in some setting.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

outcome Reference[]? - A reference to a EvidenceVariable resomece that defines the outcome for the research.

editor ContactDetail[]? - An individual or organization primarily responsible for internal coherence of the content.

identifier Identifier[]? - A formal identifier that is used to identify this evidence when it is represented in other formats, or referenced in a specification, model, design or an instance.

relatedArtifact RelatedArtifact[]? - Related artifacts such as additional documentation, justification, or bibliographic references.

effectivePeriod Period? - The period during which the evidence content was or is planned to be in active use.

author ContactDetail[]? - An individiual or organization primarily involved in the creation and maintenance of the content.

reviewer ContactDetail[]? - An individual or organization primarily responsible for review of some aspect of the content.

exposureVariant Reference[]? - A reference to a EvidenceVariable resource that defines the exposure for the research.

'version string? - The identifier that is used to identify this version of the evidence when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the evidence author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.

url uri? - An absolute URI that is used to identify this evidence when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this evidence is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the evidence is stored on different servers.

contained Resource[]? - 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.

exposureBackground Reference - A reference to a EvidenceVariable resource that defines the population for the research.

lastReviewDate date? - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

subtitle string? - An explanatory or alternate title for the Evidence giving additional information about its content.

name string? - A natural language name identifying the evidence. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher string? - The name of the organization or individual that published the evidence.

topic CodeableConcept[]? - Descriptive topics related to the content of the Evidence. Topics provide a high-level categorization grouping types of Evidences that can be useful for filtering and searching.

useContext UsageContext[]? - 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 evidence instances.

status EvidenceStatus - The status of this evidence. Enables tracking the life-cycle of the content.

never... - Rest field

health.fhir.r4: EvidenceVariable

FHIR EvidenceVariable resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_EVIDENCEVARIABLE(default RESOURCE_NAME_EVIDENCEVARIABLE) - The type of the resource describes

meta BaseEvidenceVariableMeta(default { profile : [PROFILE_BASE_EVIDENCEVARIABLE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime? - The date (and optionally time) when the evidence variable was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the evidence variable changes.

note Annotation[]? - A human-readable string to clarify or explain concepts about the resource.

copyright markdown? - A copyright statement relating to the evidence variable and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the evidence variable.

extension Extension[]? - 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.

approvalDate date? - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

jurisdiction CodeableConcept[]? - A legal or geographic region in which the evidence variable is intended to be used.

modifierExtension Extension[]? - 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).

description markdown? - A free text natural language description of the evidence variable from a consumer's perspective.

language code? - The base language in which the resource is written.

shortTitle string? - The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.

title string? - A short, descriptive, user-friendly title for the evidence variable.

'type EvidenceVariableType? - The type of evidence element, a population, an exposure, or an outcome.

characteristic EvidenceVariableCharacteristic[] - A characteristic that defines the members of the evidence element. Multiple characteristics are applied with 'and' semantics.

contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.

endorser ContactDetail[]? - An individual or organization responsible for officially endorsing the content for use in some setting.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

editor ContactDetail[]? - An individual or organization primarily responsible for internal coherence of the content.

identifier Identifier[]? - A formal identifier that is used to identify this evidence variable when it is represented in other formats, or referenced in a specification, model, design or an instance.

relatedArtifact RelatedArtifact[]? - Related artifacts such as additional documentation, justification, or bibliographic references.

effectivePeriod Period? - The period during which the evidence variable content was or is planned to be in active use.

author ContactDetail[]? - An individiual or organization primarily involved in the creation and maintenance of the content.

reviewer ContactDetail[]? - An individual or organization primarily responsible for review of some aspect of the content.

'version string? - The identifier that is used to identify this version of the evidence variable when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the evidence variable author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.

url uri? - An absolute URI that is used to identify this evidence variable when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this evidence variable is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the evidence variable is stored on different servers.

contained Resource[]? - 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.

lastReviewDate date? - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

subtitle string? - An explanatory or alternate title for the EvidenceVariable giving additional information about its content.

name string? - A natural language name identifying the evidence variable. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher string? - The name of the organization or individual that published the evidence variable.

topic CodeableConcept[]? - Descriptive topics related to the content of the EvidenceVariable. Topics provide a high-level categorization grouping types of EvidenceVariables that can be useful for filtering and searching.

useContext UsageContext[]? - 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 evidence variable instances.

status EvidenceVariableStatus - The status of this evidence variable. Enables tracking the life-cycle of the content.

never... - Rest field

health.fhir.r4: EvidenceVariableCharacteristic

Closed record

FHIR EvidenceVariableCharacteristic datatype record.

Fields

participantEffectiveTiming Timing? - Indicates what effective period the study covers.

definitionCodeableConcept CodeableConcept - Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).

participantEffectivePeriod Period? - Indicates what effective period the study covers.

usageContext UsageContext[]? - Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.

definitionCanonical canonical - Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).

extension Extension[]? - 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.

definitionDataRequirement DataRequirement - Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).

groupMeasure EvidenceVariableCharacteristicGroupMeasure? - Indicates how elements are aggregated within the study effective period.

participantEffectiveDateTime dateTime? - Indicates what effective period the study covers.

timeFromStart Duration? - Indicates duration from the participant's study entry.

definitionReference Reference - Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).

modifierExtension Extension[]? - 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).

description string? - A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user.

definitionExpression Expression - Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).

definitionTriggerDefinition TriggerDefinition - Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).

exclude boolean? - When true, members with this characteristic are excluded from the element.

participantEffectiveDuration Duration? - Indicates what effective period the study covers.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ExampleScenario

FHIR ExampleScenario resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_EXAMPLESCENARIO(default RESOURCE_NAME_EXAMPLESCENARIO) - The type of the resource describes

meta BaseExampleScenarioMeta(default { profile : [PROFILE_BASE_EXAMPLESCENARIO] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime? - The date (and optionally time) when the example scenario was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the example scenario changes. (e.g. the 'content logical definition').

copyright markdown? - A copyright statement relating to the example scenario and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the example scenario.

extension Extension[]? - 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.

instance ExampleScenarioInstance[]? - Each resource and each version that is present in the workflow.

purpose markdown? - What the example scenario resource is created for. This should not be used to show the business purpose of the scenario itself, but the purpose of documenting a scenario.

jurisdiction CodeableConcept[]? - A legal or geographic region in which the example scenario is intended to be used.

modifierExtension Extension[]? - 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).

experimental boolean? - A Boolean value to indicate that this example scenario is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language code? - The base language in which the resource is written.

contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

identifier Identifier[]? - A formal identifier that is used to identify this example scenario when it is represented in other formats, or referenced in a specification, model, design or an instance.

process ExampleScenarioProcess[]? - Each major process - a group of operations.

workflow canonical[]? - Another nested workflow.

'version string? - The identifier that is used to identify this version of the example scenario when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the example scenario author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

url uri? - An absolute URI that is used to identify this example scenario when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this example scenario is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the example scenario is stored on different servers.

actor ExampleScenarioActor[]? - Actor participating in the resource.

contained Resource[]? - 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.

name string? - A natural language name identifying the example scenario. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher string? - The name of the organization or individual that published the example scenario.

useContext UsageContext[]? - 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 example scenario instances.

status ExampleScenarioStatus - The status of this example scenario. Enables tracking the life-cycle of the content.

never... - Rest field

health.fhir.r4: ExampleScenarioActor

Closed record

FHIR ExampleScenarioActor datatype record.

Fields

extension Extension[]? - 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.

actorId string - ID or acronym of actor.

modifierExtension Extension[]? - 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).

name string? - The name of the actor as shown in the page.

description markdown? - The description of the actor.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type ExampleScenarioActorType - The type of actor - person or system.

health.fhir.r4: ExampleScenarioInstance

Closed record

FHIR ExampleScenarioInstance datatype record.

Fields

extension Extension[]? - 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.

resourceId string - The id of the resource for referencing.

modifierExtension Extension[]? - 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).

name string? - A short name for the resource instance.

description markdown? - Human-friendly description of the resource instance.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

containedInstance ExampleScenarioInstanceContainedInstance[]? - Resources contained in the instance (e.g. the observations contained in a bundle).

'version ExampleScenarioInstanceVersion[]? - A specific version of the resource.

resourceType code - The type of the resource.

health.fhir.r4: ExampleScenarioInstanceContainedInstance

Closed record

FHIR ExampleScenarioInstanceContainedInstance datatype record.

Fields

extension Extension[]? - 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.

resourceId string - Each resource contained in the instance.

versionId string? - A specific version of a resource contained in the instance.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ExampleScenarioInstanceVersion

Closed record

FHIR ExampleScenarioInstanceVersion datatype record.

Fields

extension Extension[]? - 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.

versionId string - The identifier of a specific version of a resource.

modifierExtension Extension[]? - 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).

description markdown - The description of the resource version.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ExampleScenarioProcess

Closed record

FHIR ExampleScenarioProcess datatype record.

Fields

extension Extension[]? - 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.

postConditions markdown? - Description of final status after the process ends.

preConditions markdown? - Description of initial status before the process starts.

modifierExtension Extension[]? - 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).

description markdown? - A longer description of the group of operations.

step ExampleScenarioProcessStep[]? - Each step of the process.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

title string - The diagram title of the group of operations.

health.fhir.r4: ExampleScenarioProcessStep

Closed record

FHIR ExampleScenarioProcessStep datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

alternative ExampleScenarioProcessStepAlternative[]? - Indicates an alternative step that can be taken instead of the operations on the base step in exceptional/atypical circumstances.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

operation ExampleScenarioProcessStepOperation? - Each interaction or action.

pause boolean? - If there is a pause in the flow.

health.fhir.r4: ExampleScenarioProcessStepAlternative

Closed record

FHIR ExampleScenarioProcessStepAlternative datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

description markdown? - A human-readable description of the alternative explaining when the alternative should occur rather than the base step.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

title string - The label to display for the alternative that gives a sense of the circumstance in which the alternative should be invoked.

health.fhir.r4: ExampleScenarioProcessStepOperation

Closed record

FHIR ExampleScenarioProcessStepOperation datatype record.

Fields

number string - The sequential number of the interaction, e.g. 1.2.5.

extension Extension[]? - 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.

receiver string? - Who receives the transaction.

initiator string? - Who starts the transaction.

modifierExtension Extension[]? - 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).

name string? - The human-friendly name of the interaction.

description markdown? - A comment to be inserted in the diagram.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

receiverActive boolean? - Whether the receiver is deactivated right after the transaction.

'type string? - The type of operation - CRUD.

initiatorActive boolean? - Whether the initiator is deactivated right after the transaction.

health.fhir.r4: ExplanationOfBenefit

FHIR ExplanationOfBenefit resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_EXPLANATIONOFBENEFIT(default RESOURCE_NAME_EXPLANATIONOFBENEFIT) - The type of the resource describes

meta BaseExplanationOfBenefitMeta(default { profile : [PROFILE_BASE_EXPLANATIONOFBENEFIT] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

benefitPeriod Period? - The term of the benefits documented in this response.

insurance ExplanationOfBenefitInsurance[] - Financial instruments for reimbursement for the health care products and services specified on the claim.

claimResponse Reference? - The business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response.

use ExplanationOfBenefitUse - A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.

modifierExtension Extension[]? - 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).

preAuthRef string[]? - Reference from the Insurer which is used in later communications which refers to this adjudication.

language code? - The base language in which the resource is written.

'type CodeableConcept - The category of claim, e.g. oral, pharmacy, vision, institutional, professional.

precedence positiveInt? - This indicates the relative order of a series of EOBs related to different coverages for the same suite of services.

processNote ExplanationOfBenefitProcessNote[]? - A note that describes or explains adjudication results in a human readable form.

payee ExplanationOfBenefitPayee? - The party to be reimbursed for cost of the products and services according to the terms of the policy.

supportingInfo ExplanationOfBenefitSupportingInfo[]? - Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.

claim Reference? - The business identifier for the instance of the adjudication request: claim predetermination or preauthorization.

enterer Reference? - Individual who created the claim, predetermination or preauthorization.

payment ExplanationOfBenefitPayment? - Payment details for the adjudication of the claim.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

careTeam ExplanationOfBenefitCareTeam[]? - The members of the team who provided the products and services.

identifier Identifier[]? - A unique identifier assigned to this explanation of benefit.

item ExplanationOfBenefitItem[]? - A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.

created dateTime - The date this resource was created.

diagnosis ExplanationOfBenefitDiagnosis[]? - Information about diagnoses relevant to the claim items.

priority CodeableConcept? - The provider-required urgency of processing the request. Typical values include: stat, routine deferred.

preAuthRefPeriod Period[]? - The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided.

billablePeriod Period? - The period for which charges are being submitted.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

subType CodeableConcept? - A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

status ExplanationOfBenefitStatus - The status of the resource instance.

extension Extension[]? - 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.

benefitBalance ExplanationOfBenefitBenefitBalance[]? - Balance by Benefit Category.

accident ExplanationOfBenefitAccident? - Details of a accident which resulted in injuries which required the products and services listed in the claim.

addItem ExplanationOfBenefitAddItem[]? - The first-tier service adjudications for payor added product or service lines.

total ExplanationOfBenefitTotal[]? - Categorized monetary totals for the adjudication.

fundsReserve CodeableConcept? - A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.

fundsReserveRequested CodeableConcept? - A code to indicate whether and for whom funds are to be reserved for future claims.

provider Reference - The provider which is responsible for the claim, predetermination or preauthorization.

insurer Reference - The party responsible for authorization, adjudication and reimbursement.

patient Reference - The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for forecast reimbursement is sought.

outcome ExplanationOfBenefitOutcome - The outcome of the claim, predetermination, or preauthorization processing.

formCode CodeableConcept? - A code for the form to be used for printing the content.

originalPrescription Reference? - Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.

procedure ExplanationOfBenefitProcedure[]? - Procedures performed on the patient relevant to the billing items with the claim.

contained Resource[]? - 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.

disposition string? - A human readable description of the status of the adjudication.

referral Reference? - A reference to a referral resource.

form Attachment? - The actual form, by reference or inclusion, for printing the content or an EOB.

prescription Reference? - Prescription to support the dispensing of pharmacy, device or vision products.

facility Reference? - Facility where the services were provided.

never... - Rest field

health.fhir.r4: ExplanationOfBenefitAccident

Closed record

FHIR ExplanationOfBenefitAccident datatype record.

Fields

date date? - Date of an accident event related to the products and services contained in the claim.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

locationAddress Address? - The physical location of the accident event.

locationReference Reference? - The physical location of the accident event.

'type CodeableConcept? - The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers.

health.fhir.r4: ExplanationOfBenefitAddItem

Closed record

FHIR ExplanationOfBenefitAddItem datatype record.

Fields

unitPrice Money? - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

extension Extension[]? - 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.

quantity Quantity? - The number of repetitions of a service or product.

programCode CodeableConcept[]? - Identifies the program under which this may be recovered.

modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension Extension[]? - 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).

locationAddress Address? - Where the product or service was provided.

productOrService CodeableConcept - When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

noteNumber positiveInt[]? - The numbers associated with notes below which apply to the adjudication of this item.

servicedPeriod Period? - The date or dates when the service or product was supplied, performed or completed.

subDetailSequence positiveInt[]? - The sequence number of the sub-details woithin the details within the claim item which this line is intended to replace.

itemSequence positiveInt[]? - Claim items which this service line is intended to replace.

bodySite CodeableConcept? - Physical service site on the patient (limb, tooth, etc.).

locationCodeableConcept CodeableConcept? - Where the product or service was provided.

provider Reference[]? - The providers who are authorized for the services rendered to the patient.

detailSequence positiveInt[]? - The sequence number of the details within the claim item which this line is intended to replace.

subSite CodeableConcept[]? - A region or surface of the bodySite, e.g. limb region or tooth surface(s).

detail ExplanationOfBenefitAddItemDetail[]? - The second-tier service adjudications for payor added services.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

locationReference Reference? - Where the product or service was provided.

servicedDate date? - The date or dates when the service or product was supplied, performed or completed.

factor decimal? - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net Money? - The quantity times the unit price for an additional service or product or charge.

health.fhir.r4: ExplanationOfBenefitAddItemDetail

Closed record

FHIR ExplanationOfBenefitAddItemDetail datatype record.

Fields

unitPrice Money? - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

extension Extension[]? - 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.

quantity Quantity? - The number of repetitions of a service or product.

modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension Extension[]? - 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).

subDetail ExplanationOfBenefitAddItemDetailSubDetail[]? - The third-tier service adjudications for payor added services.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

productOrService CodeableConcept - When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

factor decimal? - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net Money? - The quantity times the unit price for an additional service or product or charge.

noteNumber positiveInt[]? - The numbers associated with notes below which apply to the adjudication of this item.

health.fhir.r4: ExplanationOfBenefitAddItemDetailSubDetail

Closed record

FHIR ExplanationOfBenefitAddItemDetailSubDetail datatype record.

Fields

unitPrice Money? - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

extension Extension[]? - 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.

quantity Quantity? - The number of repetitions of a service or product.

modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

productOrService CodeableConcept - When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

factor decimal? - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net Money? - The quantity times the unit price for an additional service or product or charge.

noteNumber positiveInt[]? - The numbers associated with notes below which apply to the adjudication of this item.

health.fhir.r4: ExplanationOfBenefitBenefitBalance

Closed record

FHIR ExplanationOfBenefitBenefitBalance datatype record.

Fields

excluded boolean? - True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.

extension Extension[]? - 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.

unit CodeableConcept? - Indicates if the benefits apply to an individual or to the family.

financial ExplanationOfBenefitBenefitBalanceFinancial[]? - Benefits Used to date.

modifierExtension Extension[]? - 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).

name string? - A short name or tag for the benefit.

description string? - A richer description of the benefit or services covered.

term CodeableConcept? - The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category CodeableConcept - Code to identify the general type of benefits under which products and services are provided.

network CodeableConcept? - Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.

health.fhir.r4: ExplanationOfBenefitBenefitBalanceFinancial

Closed record

FHIR ExplanationOfBenefitBenefitBalanceFinancial datatype record.

Fields

allowedMoney Money? - The quantity of the benefit which is permitted under the coverage.

extension Extension[]? - 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.

allowedString string? - The quantity of the benefit which is permitted under the coverage.

allowedUnsignedInt unsignedInt? - The quantity of the benefit which is permitted under the coverage.

usedUnsignedInt unsignedInt? - The quantity of the benefit which have been consumed to date.

modifierExtension Extension[]? - 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).

usedMoney Money? - The quantity of the benefit which have been consumed to date.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - Classification of benefit being provided.

health.fhir.r4: ExplanationOfBenefitCareTeam

Closed record

FHIR ExplanationOfBenefitCareTeam datatype record.

Fields

qualification CodeableConcept? - The qualification of the practitioner which is applicable for this service.

sequence positiveInt - A number to uniquely identify care team entries.

extension Extension[]? - 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.

role CodeableConcept? - The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team.

provider Reference - Member of the team who provided the product or service.

modifierExtension Extension[]? - 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).

responsible boolean? - The party who is billing and/or responsible for the claimed products or services.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ExplanationOfBenefitDiagnosis

Closed record

FHIR ExplanationOfBenefitDiagnosis datatype record.

Fields

sequence positiveInt - A number to uniquely identify diagnosis entries.

extension Extension[]? - 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.

onAdmission CodeableConcept? - Indication of whether the diagnosis was present on admission to a facility.

packageCode CodeableConcept? - A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept[]? - When the condition was observed or the relative ranking.

diagnosisReference Reference - The nature of illness or problem in a coded form or as a reference to an external defined Condition.

diagnosisCodeableConcept CodeableConcept - The nature of illness or problem in a coded form or as a reference to an external defined Condition.

health.fhir.r4: ExplanationOfBenefitInsurance

Closed record

FHIR ExplanationOfBenefitInsurance datatype record.

Fields

coverage Reference - Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.

extension Extension[]? - 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.

focal boolean - A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.

modifierExtension Extension[]? - 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).

preAuthRef string[]? - Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ExplanationOfBenefitItem

Closed record

FHIR ExplanationOfBenefitItem datatype record.

Fields

extension Extension[]? - 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.

modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension Extension[]? - 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).

locationAddress Address? - Where the product or service was provided.

productOrService CodeableConcept - When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

noteNumber positiveInt[]? - The numbers associated with notes below which apply to the adjudication of this item.

servicedPeriod Period? - The date or dates when the service or product was supplied, performed or completed.

adjudication ExplanationOfBenefitItemAdjudication[]? - If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.

informationSequence positiveInt[]? - Exceptions, special conditions and supporting information applicable for this service or product.

revenue CodeableConcept? - The type of revenue or cost center providing the product and/or service.

locationCodeableConcept CodeableConcept? - Where the product or service was provided.

diagnosisSequence positiveInt[]? - Diagnoses applicable for this service or product.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

locationReference Reference? - Where the product or service was provided.

factor decimal? - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net Money? - The quantity times the unit price for an additional service or product or charge.

unitPrice Money? - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

quantity Quantity? - The number of repetitions of a service or product.

programCode CodeableConcept[]? - Identifies the program under which this may be recovered.

careTeamSequence positiveInt[]? - Care team members related to this service or product.

encounter Reference[]? - A billed item may include goods or services provided in multiple encounters.

sequence positiveInt - A number to uniquely identify item entries.

bodySite CodeableConcept? - Physical service site on the patient (limb, tooth, etc.).

subSite CodeableConcept[]? - A region or surface of the bodySite, e.g. limb region or tooth surface(s).

detail ExplanationOfBenefitItemDetail[]? - Second-tier of goods and services.

servicedDate date? - The date or dates when the service or product was supplied, performed or completed.

udi Reference[]? - Unique Device Identifiers associated with this line item.

category CodeableConcept? - Code to identify the general type of benefits under which products and services are provided.

procedureSequence positiveInt[]? - Procedures applicable for this service or product.

health.fhir.r4: ExplanationOfBenefitItemAdjudication

Closed record

FHIR ExplanationOfBenefitItemAdjudication datatype record.

Fields

reason CodeableConcept? - A code supporting the understanding of the adjudication result and explaining variance from expected amount.

amount Money? - Monetary amount associated with the category.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category CodeableConcept - A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in-aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

value decimal? - A non-monetary value associated with the category. Mutually exclusive to the amount element above.

health.fhir.r4: ExplanationOfBenefitItemDetail

Closed record

FHIR ExplanationOfBenefitItemDetail datatype record.

Fields

unitPrice Money? - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

extension Extension[]? - 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.

quantity Quantity? - The number of repetitions of a service or product.

programCode CodeableConcept[]? - Identifies the program under which this may be recovered.

modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension Extension[]? - 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).

subDetail ExplanationOfBenefitItemDetailSubDetail[]? - Third-tier of goods and services.

productOrService CodeableConcept - When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

noteNumber positiveInt[]? - The numbers associated with notes below which apply to the adjudication of this item.

sequence positiveInt - A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

revenue CodeableConcept? - The type of revenue or cost center providing the product and/or service.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

udi Reference[]? - Unique Device Identifiers associated with this line item.

category CodeableConcept? - Code to identify the general type of benefits under which products and services are provided.

factor decimal? - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net Money? - The quantity times the unit price for an additional service or product or charge.

health.fhir.r4: ExplanationOfBenefitItemDetailSubDetail

Closed record

FHIR ExplanationOfBenefitItemDetailSubDetail datatype record.

Fields

unitPrice Money? - If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

extension Extension[]? - 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.

quantity Quantity? - The number of repetitions of a service or product.

programCode CodeableConcept[]? - Identifies the program under which this may be recovered.

modifier CodeableConcept[]? - Item typification or modifiers codes to convey additional context for the product or service.

modifierExtension Extension[]? - 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).

productOrService CodeableConcept - When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

noteNumber positiveInt[]? - The numbers associated with notes below which apply to the adjudication of this item.

sequence positiveInt - A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

revenue CodeableConcept? - The type of revenue or cost center providing the product and/or service.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

udi Reference[]? - Unique Device Identifiers associated with this line item.

category CodeableConcept? - Code to identify the general type of benefits under which products and services are provided.

factor decimal? - A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

net Money? - The quantity times the unit price for an additional service or product or charge.

health.fhir.r4: ExplanationOfBenefitPayee

Closed record

FHIR ExplanationOfBenefitPayee datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept? - Type of Party to be reimbursed: Subscriber, provider, other.

party Reference? - Reference to the individual or organization to whom any payment will be made.

health.fhir.r4: ExplanationOfBenefitPayment

Closed record

FHIR ExplanationOfBenefitPayment datatype record.

Fields

date date? - Estimated date the payment will be issued or the actual issue date of payment.

identifier Identifier? - Issuer's unique identifier for the payment instrument.

adjustmentReason CodeableConcept? - Reason for the payment adjustment.

amount Money? - Benefits payable less any payment adjustment.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

adjustment Money? - Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept? - Whether this represents partial or complete payment of the benefits payable.

health.fhir.r4: ExplanationOfBenefitProcedure

Closed record

FHIR ExplanationOfBenefitProcedure datatype record.

Fields

date dateTime? - Date and optionally time the procedure was performed.

sequence positiveInt - A number to uniquely identify procedure entries.

extension Extension[]? - 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.

procedureCodeableConcept CodeableConcept - The code or reference to a Procedure resource which identifies the clinical intervention performed.

modifierExtension Extension[]? - 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).

procedureReference Reference - The code or reference to a Procedure resource which identifies the clinical intervention performed.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

udi Reference[]? - Unique Device Identifiers associated with this line item.

'type CodeableConcept[]? - When the condition was observed or the relative ranking.

health.fhir.r4: ExplanationOfBenefitProcessNote

Closed record

FHIR ExplanationOfBenefitProcessNote datatype record.

Fields

number positiveInt? - A number to uniquely identify a note entry.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

language CodeableConcept? - A code to define the language used in the text of the note.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - The explanation or description associated with the processing.

'type ExplanationOfBenefitProcessNoteType? - The business purpose of the note text.

health.fhir.r4: ExplanationOfBenefitRelated

Closed record

FHIR ExplanationOfBenefitRelated datatype record.

Fields

reference Identifier? - An alternate organizational reference to the case or file to which this particular claim pertains.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

claim Reference? - Reference to a related claim.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

relationship CodeableConcept? - A code to convey how the claims are related.

health.fhir.r4: ExplanationOfBenefitSupportingInfo

Closed record

FHIR ExplanationOfBenefitSupportingInfo datatype record.

Fields

valueBoolean boolean? - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

reason Coding? - Provides the reason in the situation where a reason code is required in addition to the content.

extension Extension[]? - 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.

code CodeableConcept? - System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.

valueReference Reference? - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

timingPeriod Period? - The date when or period to which this information refers.

modifierExtension Extension[]? - 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).

timingDate date? - The date when or period to which this information refers.

sequence positiveInt - A number to uniquely identify supporting information entries.

valueAttachment Attachment? - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

valueString string? - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category CodeableConcept - The general class of the information supplied: information; exception; accident, employment; onset, etc.

valueQuantity Quantity? - Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

health.fhir.r4: ExplanationOfBenefitTotal

Closed record

FHIR ExplanationOfBenefitTotal datatype record.

Fields

amount Money - Monetary total amount associated with the category.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category CodeableConcept - A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

health.fhir.r4: Expression

An expression that can be used to generate a value.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

description string? - Natural language description of the condition

name id? - Short name assigned to expression for reuse

language code - text/cql | text/fhirpath | application/x-fhir-query | text/cql-identifier | text/cql-expression | etc.

expression string? - Expression in specified language

reference uri? - Where the expression is found

health.fhir.r4: ExpressionExtension

Closed record

Fields

url uri -

valueExpression Expression -

health.fhir.r4: ExtendedContactDetail

Closed record

Fields

purpose CodeableConcept? -

name HumanName? -

telecom ContactPoint? -

address Address? -

organization Reference? -

period Period? -

health.fhir.r4: ExtendedContactDetailExtension

Closed record

Fields

url uri -

valueExtendedContactDetail ExtendedContactDetail -

health.fhir.r4: ExtensionExtension

Closed record

Every element in a resource or data type includes an optional "extension" child element that may be present any number of times.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

url uri - identifies the meaning of the extension

extension Extension[]? - Additional content defined by implementations

health.fhir.r4: FamilyMemberHistory

FHIR FamilyMemberHistory resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_FAMILYMEMBERHISTORY(default RESOURCE_NAME_FAMILYMEMBERHISTORY) - The type of the resource describes

meta BaseFamilyMemberHistoryMeta(default { profile : [PROFILE_BASE_FAMILYMEMBERHISTORY] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ageRange Range? - The age of the relative at the time the family member history is recorded.

date dateTime? - The date (and possibly time) when the family member history was recorded or last updated.

dataAbsentReason CodeableConcept? - Describes why the family member's history is not available.

note Annotation[]? - This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

reasonReference Reference[]? - Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.

language code? - The base language in which the resource is written.

bornString string? - The actual or approximate date of birth of the relative.

instantiatesUri uri[]? - The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

estimatedAge boolean? - If true, indicates that the age value specified is an estimated value.

patient Reference - The person who this history concerns.

deceasedRange Range? - Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

reasonCode CodeableConcept[]? - Describes why the family member history occurred in coded or textual form.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

relationship CodeableConcept - The type of relationship this person has to the patient (father, mother, brother etc.).

ageAge Age? - The age of the relative at the time the family member history is recorded.

identifier Identifier[]? - Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

ageString string? - The age of the relative at the time the family member history is recorded.

sex CodeableConcept? - The birth sex of the family member.

bornDate date? - The actual or approximate date of birth of the relative.

instantiatesCanonical canonical[]? - The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

bornPeriod Period? - The actual or approximate date of birth of the relative.

condition FamilyMemberHistoryCondition[]? - The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.

contained Resource[]? - 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.

deceasedBoolean boolean? - Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

deceasedString string? - Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

name string? - This will either be a name or a description; e.g. 'Aunt Susan', 'my cousin with the red hair'.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

deceasedDate date? - Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

deceasedAge Age? - Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

status FamilyMemberHistoryStatus - A code specifying the status of the record of the family history of a specific family member.

never... - Rest field

health.fhir.r4: FamilyMemberHistoryCondition

Closed record

FHIR FamilyMemberHistoryCondition datatype record.

Fields

contributedToDeath boolean? - This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.

note Annotation[]? - An area where general notes can be placed about this specific condition.

extension Extension[]? - 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.

code CodeableConcept - The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system.

onsetPeriod Period? - Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.

onsetRange Range? - Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

onsetString string? - Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.

onsetAge Age? - Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.

outcome CodeableConcept? - Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation.

health.fhir.r4: FHIRCreateInteraction

FHIR Create interaction.

Fields

Fields Included from *FHIRInteraction

interaction FHIRInteractionType
anydata...

interaction CREATE(default CREATE) - Interaction type

health.fhir.r4: FHIRErrorDetail

FHIR error details record.

Fields

issues [FHIRIssueDetail, FHIRIssueDetail...] - FHIR issues

internalError boolean(default false) - flag to indicate the FHIRError is an internal error

httpStatusCode int(default http:STATUS_INTERNAL_SERVER_ERROR) - HTTP status code to return to the client

uuid string(default uuid:createType1AsString()) - UUID of the error

health.fhir.r4: FHIRInteraction

FHIR Interaction.

Fields

interaction FHIRInteractionType - Interaction type

health.fhir.r4: FHIRIssueDetail

FHIR Error Detail structure.

Fields

severity Severity - severity of the issue

code IssueType - Error or warning code

details CodeableConcept?(default ()) - Additional details about the error

diagnostic string?(default ()) - Additional diagnostic information about the issue

expression string[]?(default ()) - FHIRPath of element(s) related to issue

health.fhir.r4: FHIROperationDefinition

Closed record

Operation definition representing summary information reqiored for processing from spec.

Fields

name string - name of the operation

instanceLevel boolean - active in instance interaction level

typeLevel boolean - active in type interaction level

systemLevel boolean - active in system interaction level

health.fhir.r4: FHIRReadInteraction

FHIR Read interaction.

Fields

Fields Included from *FHIRInteraction

interaction FHIRInteractionType
anydata...

interaction READ(default READ) - Interaction type

id string - target resource id

health.fhir.r4: FHIRSearchInteraction

FHIR Search interaction.

Fields

Fields Included from *FHIRInteraction

interaction FHIRInteractionType
anydata...

interaction SEARCH(default SEARCH) - Interaction type

defaultProfile string? - International resource URL will set as default.

health.fhir.r4: FHIRSearchParameterDefinition

Search parameter definition representing summary information reqiored for processing from spec.

Fields

name string - name of the search parameter

'type FHIRSearchParameterType - type of the search parameter

base string[] - The resource type this search parameter applies to

expression string - expression bound to the resource type

health.fhir.r4: FHIRSecurity

Record to hold information about FHIR related security.

Fields

securedAPICall readonly & boolean - indicate whether the API call is originated from secured API or not

fhirUser readonly & FHIRUser? - FHIR User information

jwt readonly & JWT? - decoded JWT assertion

health.fhir.r4: FHIRTypedSearchParameter

Base type of decoded/processed search parameter value.

Fields

modifierreadonly FHIRSearchParameterModifier|string? - FHIR Search parameter modifier

health.fhir.r4: FHIRUpdateInteraction

FHIR Update interaction.

Fields

Fields Included from *FHIRInteraction

interaction FHIRInteractionType
anydata...

interaction UPDATE(default UPDATE) - Interaction type

id string - Target resource id

health.fhir.r4: FHIRUser

Record to wrap JWT user information.

Fields

scopes readonly & string[] - The list of scopes the particular user have.

userID readonly & string - Unique user identifier.

claims readonly & map<string> - The user claims given by the identitty provider

health.fhir.r4: Flag

FHIR Flag resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_FLAG(default RESOURCE_NAME_FLAG) - The type of the resource describes

meta BaseFlagMeta(default { profile : [PROFILE_BASE_FLAG] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

identifier Identifier[]? - Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

extension Extension[]? - 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.

period Period? - The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified.

code CodeableConcept - The coded value or textual component of the flag to display to the user.

author Reference? - The person, organization or device that created the flag.

subject Reference - The patient, location, group, organization, or practitioner etc. this is about record this flag is associated with.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

encounter Reference? - This alert is only relevant during the encounter.

contained Resource[]? - 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.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

category CodeableConcept[]? - Allows a flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context.

status FlagStatus - Supports basic workflow.

never... - Rest field

health.fhir.r4: Goal

FHIR Goal resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_GOAL(default RESOURCE_NAME_GOAL) - The type of the resource describes

meta BaseGoalMeta(default { profile : [PROFILE_BASE_GOAL] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

statusDate date? - Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.

note Annotation[]? - Any comments related to the goal.

addresses Reference[]? - The identified conditions and other health record elements that are intended to be addressed by the goal.

extension Extension[]? - 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.

lifecycleStatus GoalLifecycleStatus - The state of the goal throughout its lifecycle.

outcomeReference Reference[]? - Details of what's changed (or not changed).

subject Reference - Identifies the patient, group or organization for whom the goal is being established.

modifierExtension Extension[]? - 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).

description CodeableConcept - Human-readable and/or coded description of a specific desired objective of care, such as 'control blood pressure' or 'negotiate an obstacle course' or 'dance with child at wedding'.

language code? - The base language in which the resource is written.

outcomeCode CodeableConcept[]? - Identifies the change (or lack of change) at the point when the status of the goal is assessed.

statusReason string? - Captures the reason for the current status.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

identifier Identifier[]? - Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

priority CodeableConcept? - Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.

target GoalTarget[]? - Indicates what should be done by when.

contained Resource[]? - 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.

expressedBy Reference? - Indicates whose goal this is - patient goal, practitioner goal, etc.

startCodeableConcept CodeableConcept? - The date or event after which the goal should begin being pursued.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

achievementStatus CodeableConcept? - Describes the progression, or lack thereof, towards the goal against the target.

category CodeableConcept[]? - Indicates a category the goal falls within.

startDate date? - The date or event after which the goal should begin being pursued.

never... - Rest field

health.fhir.r4: GoalTarget

Closed record

FHIR GoalTarget datatype record.

Fields

detailRange Range? - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

extension Extension[]? - 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.

detailQuantity Quantity? - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

dueDate date? - Indicates either the date or the duration after start by which the goal should be met.

modifierExtension Extension[]? - 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).

detailString string? - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

detailBoolean boolean? - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

dueDuration Duration? - Indicates either the date or the duration after start by which the goal should be met.

measure CodeableConcept? - The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.

detailRatio Ratio? - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

detailInteger integer? - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

detailCodeableConcept CodeableConcept? - The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: GraphDefinition

FHIR GraphDefinition resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_GRAPHDEFINITION(default RESOURCE_NAME_GRAPHDEFINITION) - The type of the resource describes

meta BaseGraphDefinitionMeta(default { profile : [PROFILE_BASE_GRAPHDEFINITION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime? - The date (and optionally time) when the graph definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the graph definition changes.

extension Extension[]? - 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.

purpose markdown? - Explanation of why this graph definition is needed and why it has been designed as it has.

jurisdiction CodeableConcept[]? - A legal or geographic region in which the graph definition is intended to be used.

modifierExtension Extension[]? - 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).

profile canonical? - The profile that describes the use of the base resource.

link GraphDefinitionLink[]? - Links this graph makes rules about.

'start code - The type of FHIR resource at which instances of this graph start.

description markdown? - A free text natural language description of the graph definition from a consumer's perspective.

experimental boolean? - A Boolean value to indicate that this graph definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language code? - The base language in which the resource is written.

'version string? - The identifier that is used to identify this version of the graph definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the graph definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

url uri? - An absolute URI that is used to identify this graph definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this graph definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the graph definition is stored on different servers.

contained Resource[]? - 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.

contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.

name string - A natural language name identifying the graph definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher string? - The name of the organization or individual that published the graph definition.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

useContext UsageContext[]? - 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 graph definition instances.

status GraphDefinitionStatus - The status of this graph definition. Enables tracking the life-cycle of the content.

never... - Rest field

health.fhir.r4: GraphDefinitionLink

Closed record

FHIR GraphDefinitionLink datatype record.

Fields

path string? - A FHIR expression that identifies one of FHIR References to other resources.

extension Extension[]? - 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.

sliceName string? - Which slice (if profiled).

min integer? - Minimum occurrences for this link.

max string? - Maximum occurrences for this link.

modifierExtension Extension[]? - 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).

description string? - Information about why this link is of interest in this graph definition.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

target GraphDefinitionLinkTarget[]? - Potential target for the link.

health.fhir.r4: GraphDefinitionLinkTarget

Closed record

FHIR GraphDefinitionLinkTarget datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

profile canonical? - Profile for the target resource.

compartment GraphDefinitionLinkTargetCompartment[]? - Compartment Consistency Rules.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

params string? - A set of parameters to look up.

'type code - Type of resource this link refers to.

health.fhir.r4: GraphDefinitionLinkTargetCompartment

Closed record

FHIR GraphDefinitionLinkTargetCompartment datatype record.

Fields

extension Extension[]? - 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.

code GraphDefinitionLinkTargetCompartmentCode - Identifies the compartment.

expression string? - Custom rule, as a FHIRPath expression.

use GraphDefinitionLinkTargetCompartmentUse - Defines how the compartment rule is used - whether it it is used to test whether resources are subject to the rule, or whether it is a rule that must be followed.

modifierExtension Extension[]? - 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).

description string? - Documentation for FHIRPath expression.

rule GraphDefinitionLinkTargetCompartmentRule - identical | matching | different | no-rule | custom.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: Group

FHIR Group resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_GROUP(default RESOURCE_NAME_GROUP) - The type of the resource describes

meta BaseGroupMeta(default { profile : [PROFILE_BASE_GROUP] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

actual boolean - If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.

identifier Identifier[]? - A unique business identifier for this group.

extension Extension[]? - 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.

code CodeableConcept? - Provides a specific type of resource the group includes; e.g. 'cow', 'syringe', etc.

quantity unsignedInt? - A count of the number of resource instances that are part of the group.

modifierExtension Extension[]? - 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).

active boolean? - Indicates whether the record for the group is available for use or is merely being retained for historical purposes.

language code? - The base language in which the resource is written.

'type GroupType - Identifies the broad classification of the kind of resources the group includes.

characteristic GroupCharacteristic[]? - Identifies traits whose presence r absence is shared by members of the group.

managingEntity Reference? - Entity responsible for defining and maintaining Group characteristics and/or registered members.

contained Resource[]? - 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.

member GroupMember[]? - Identifies the resource instances that are members of the group.

name string? - A label assigned to the group for human identification and communication.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

never... - Rest field

health.fhir.r4: GroupCharacteristic

Closed record

FHIR GroupCharacteristic datatype record.

Fields

valueCodeableConcept CodeableConcept - The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

valueBoolean boolean - The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

extension Extension[]? - 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.

period Period? - The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.

code CodeableConcept - A code that identifies the kind of trait being asserted.

valueReference Reference - The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

valueRange Range - The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

modifierExtension Extension[]? - 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).

exclude boolean - If true, indicates the characteristic is one that is NOT held by members of the group.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueQuantity Quantity - The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

health.fhir.r4: GroupMember

Closed record

FHIR GroupMember datatype record.

Fields

extension Extension[]? - 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.

period Period? - The period that the member was in the group, if known.

inactive boolean? - A flag to indicate that the member is no longer in the group, but previously may have been a member.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

entity Reference - A reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same.

health.fhir.r4: GuidanceResponse

FHIR GuidanceResponse resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_GUIDANCERESPONSE(default RESOURCE_NAME_GUIDANCERESPONSE) - The type of the resource describes

meta BaseGuidanceResponseMeta(default { profile : [PROFILE_BASE_GUIDANCERESPONSE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

note Annotation[]? - Provides a mechanism to communicate additional information about the response.

extension Extension[]? - 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.

subject Reference? - The patient for which the request was processed.

modifierExtension Extension[]? - 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).

reasonReference Reference[]? - Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.

language code? - The base language in which the resource is written.

result Reference? - The actions, if any, produced by the evaluation of the artifact.

evaluationMessage Reference[]? - Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.

moduleCanonical canonical - An identifier, CodeableConcept or canonical reference to the guidance that was requested.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

reasonCode CodeableConcept[]? - Describes the reason for the guidance response in coded or textual form.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

moduleUri uri - An identifier, CodeableConcept or canonical reference to the guidance that was requested.

outputParameters Reference? - The output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element.

identifier Identifier[]? - Allows a service to provide unique, business identifiers for the response.

performer Reference? - Provides a reference to the device that performed the guidance.

encounter Reference? - The encounter during which this response was created or to which the creation of this record is tightly associated.

moduleCodeableConcept CodeableConcept - An identifier, CodeableConcept or canonical reference to the guidance that was requested.

contained Resource[]? - 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.

dataRequirement DataRequirement[]? - If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

occurrenceDateTime dateTime? - Indicates when the guidance response was processed.

requestIdentifier Identifier? - The identifier of the request associated with this response. If an identifier was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario.

status GuidanceResponseStatus - The status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information.

never... - Rest field

health.fhir.r4: HealthcareService

FHIR HealthcareService resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_HEALTHCARESERVICE(default RESOURCE_NAME_HEALTHCARESERVICE) - The type of the resource describes

meta BaseHealthcareServiceMeta(default { profile : [PROFILE_BASE_HEALTHCARESERVICE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

serviceProvisionCode CodeableConcept[]? - The code(s) that detail the conditions under which the healthcare service is available/offered.

extension Extension[]? - 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.

specialty CodeableConcept[]? - Collection of specialties handled by the service site. This is more of a medical term.

modifierExtension Extension[]? - 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).

eligibility HealthcareServiceEligibility[]? - Does this service have specific eligibility requirements that need to be met in order to use the service?

language code? - The base language in which the resource is written.

program CodeableConcept[]? - Programs that this service is applicable to.

'type CodeableConcept[]? - The specific type of service that may be delivered or performed.

characteristic CodeableConcept[]? - Collection of characteristics (attributes).

notAvailable HealthcareServiceNotAvailable[]? - The HealthcareService is not available during this period of time due to the provided reason.

availableTime HealthcareServiceAvailableTime[]? - A collection of times that the Service Site is available.

endpoint Reference[]? - Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.

telecom ContactPoint[]? - List of contacts related to this specific healthcare service.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

communication CodeableConcept[]? - Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used.

referralMethod CodeableConcept[]? - Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.

providedBy Reference? - The organization that provides this healthcare service.

identifier Identifier[]? - External identifiers for this item.

appointmentRequired boolean? - Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.

active boolean? - This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.

photo Attachment? - If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.

contained Resource[]? - 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.

name string? - Further description of the service as it would be presented to a consumer while searching.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

comment string? - Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.

location Reference[]? - The location(s) where this healthcare service may be provided.

category CodeableConcept[]? - Identifies the broad category of service being performed or delivered.

extraDetails markdown? - Extra details about the service that can't be placed in the other fields.

availabilityExceptions string? - A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.

coverageArea Reference[]? - The location(s) that this service is available to (not where the service is provided).

never... - Rest field

health.fhir.r4: HealthcareServiceAvailableTime

Closed record

FHIR HealthcareServiceAvailableTime datatype record.

Fields

allDay boolean? - Is this always available? (hence times are irrelevant) e.g. 24 hour service.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

availableEndTime time? - The closing time of day. Note: If the AllDay flag is set, then this time is ignored.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

daysOfWeek HealthcareServiceAvailableTimeDaysOfWeek[]? - Indicates which days of the week are available between the start and end Times.

availableStartTime time? - The opening time of day. Note: If the AllDay flag is set, then this time is ignored.

health.fhir.r4: HealthcareServiceEligibility

Closed record

FHIR HealthcareServiceEligibility datatype record.

Fields

extension Extension[]? - 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.

code CodeableConcept? - Coded value for the eligibility.

modifierExtension Extension[]? - 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).

comment markdown? - Describes the eligibility conditions for the service.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: HealthcareServiceNotAvailable

Closed record

FHIR HealthcareServiceNotAvailable datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

description string - The reason that can be presented to the user as to why this time is not available.

during Period? - Service is not available (seasonally or for a public holiday) from this date.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: HTTPRequest

Record Holding information about the HTTP request.

Fields

headers readonly & map<string[]> - map of incoming HTTP headers

payload readonly & (json|xml|string)? - HTTP payload

health.fhir.r4: HumanName

Closed record

Name of a human or other living entity - parts and usage.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

use HumanNameUse? - usual | official | temp | nickname | anonymous | old | maiden

text string? - Text representation of the full name

family string? - Family name (often called 'Surname')

given string[]? - Given names (not always 'first'). Includes middle names. This repeating element order: Given Names appear in the correct order for presenting the name

prefix string[]? - Parts that come before the name. This repeating element order: Prefixes appear in the correct order for presenting the name

suffix string[]? - Parts that come after the name. This repeating element order: Suffixes appear in the correct order for presenting the name

period Period? - Time period when name was/is in use

health.fhir.r4: HumanNameExtension

Closed record

Fields

url uri -

valueHumanName HumanName -

health.fhir.r4: Identifier

Closed record

A numeric or alphanumeric string that is associated with a single object or entity within a given system.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

use IdentifierUse? - usual | official | temp | secondary | old (If known) IdentifierUse (Required) (http://hl7.org/fhir/valueset-identifier-use.html)

'type CodeableConcept? - Description of identifier

system uri? - The namespace for the identifier value

value string? - The value that is unique

period Period? - Time period when id is/was valid for use

assigner Reference? - Organization that issued id (may be just text)

health.fhir.r4: IdentifierExtension

Closed record

Fields

url uri -

valueIdentifier Identifier -

health.fhir.r4: IdExtension

Closed record

Fields

url uri -

valueId id -

health.fhir.r4: IGInfoRecord

Closed record

Record to hold information about an implementation guide.

Fields

title readonly & string - Name for this implementation guide (human friendly)

name readonly & string - Name for this implementation guide (computer friendly)

terminology Terminology - terminology object

profiles readonly & map<Profile> - profiles supported by the IG (key : profile uri)

searchParameters readonly & map<FHIRSearchParameterDefinition[]>[] - search parameters defined in the IG (key: parameter name)

health.fhir.r4: ImagingStudy

FHIR ImagingStudy resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_IMAGINGSTUDY(default RESOURCE_NAME_IMAGINGSTUDY) - The type of the resource describes

meta BaseImagingStudyMeta(default { profile : [PROFILE_BASE_IMAGINGSTUDY] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

note Annotation[]? - Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element.

extension Extension[]? - 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.

modality Coding[]? - A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).

procedureCode CodeableConcept[]? - The code for the performed procedure type.

subject Reference - The subject, typically a patient, of the imaging study.

modifierExtension Extension[]? - 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).

description string? - The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed.

reasonReference Reference[]? - Indicates another resource whose existence justifies this Study.

language code? - The base language in which the resource is written.

endpoint Reference[]? - The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.

numberOfInstances unsignedInt? - Number of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

reasonCode CodeableConcept[]? - Description of clinical condition indicating why the ImagingStudy was requested.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

basedOn Reference[]? - A list of the diagnostic requests that resulted in this imaging study being performed.

identifier Identifier[]? - Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.

numberOfSeries unsignedInt? - Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.

interpreter Reference[]? - Who read the study and interpreted the images or other content.

started dateTime? - Date and time the study started.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made.

referrer Reference? - The requesting/referring physician.

contained Resource[]? - 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.

series ImagingStudySeries[]? - Each study has one or more series of images or other content.

procedureReference Reference? - The procedure which this ImagingStudy was part of.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

location Reference? - The principal physical location where the ImagingStudy was performed.

status ImagingStudyStatus - The current state of the ImagingStudy.

never... - Rest field

health.fhir.r4: ImagingStudySeries

Closed record

FHIR ImagingStudySeries datatype record.

Fields

extension Extension[]? - 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.

instance ImagingStudySeriesInstance[]? - A single SOP instance within the series, e.g. an image, or presentation state.

modality Coding - The modality of this series sequence.

performer ImagingStudySeriesPerformer[]? - Indicates who or what performed the series and how they were involved.

modifierExtension Extension[]? - 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).

description string? - A description of the series.

started dateTime? - The date and time the series was started.

laterality Coding? - The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite.

number unsignedInt? - The numeric identifier of this series in the study.

uid id - The DICOM Series Instance UID for the series.

bodySite Coding? - The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality.

endpoint Reference[]? - The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.connectionType.

numberOfInstances unsignedInt? - Number of SOP Instances in the Study. The value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.

specimen Reference[]? - The specimen imaged, e.g., for whole slide imaging of a biopsy.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ImagingStudySeriesInstance

Closed record

FHIR ImagingStudySeriesInstance datatype record.

Fields

number unsignedInt? - The number of instance in the series.

uid id - The DICOM SOP Instance UID for this image or other DICOM content.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

sopClass Coding - DICOM instance type.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

title string? - The description of the instance.

health.fhir.r4: ImagingStudySeriesPerformer

Closed record

FHIR ImagingStudySeriesPerformer datatype record.

Fields

actor Reference - Indicates who or what performed the series.

extension Extension[]? - 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.

'function CodeableConcept? - Distinguishes the type of involvement of the performer in the series.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: Immunization

FHIR Immunization resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_IMMUNIZATION(default RESOURCE_NAME_IMMUNIZATION) - The type of the resource describes

meta BaseImmunizationMeta(default { profile : [PROFILE_BASE_IMMUNIZATION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

note Annotation[]? - Extra information about the immunization that is not conveyed by the other attributes.

primarySource boolean? - An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.

extension Extension[]? - 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.

education ImmunizationEducation[]? - Educational material presented to the patient (or guardian) at the time of vaccine administration.

doseQuantity Quantity? - The quantity of vaccine product that was administered.

modifierExtension Extension[]? - 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).

reasonReference Reference[]? - Condition, Observation or DiagnosticReport that supports why the immunization was administered.

language code? - The base language in which the resource is written.

manufacturer Reference? - Name of vaccine manufacturer.

programEligibility CodeableConcept[]? - Indicates a patient's eligibility for a funding program.

statusReason CodeableConcept? - Indicates the reason the immunization event was not performed.

isSubpotent boolean? - Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.

patient Reference - The patient who either received or did not receive the immunization.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

reasonCode CodeableConcept[]? - Reasons why the vaccine was administered.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

vaccineCode CodeableConcept - Vaccine that was administered or was to be administered.

expirationDate date? - Date vaccine batch expires.

identifier Identifier[]? - A unique identifier assigned to this immunization record.

performer ImmunizationPerformer[]? - Indicates who performed the immunization event.

reaction ImmunizationReaction[]? - Categorical data indicating that an adverse event is associated in time to an immunization.

subpotentReason CodeableConcept[]? - Reason why a dose is considered to be subpotent.

encounter Reference? - The visit or admission or other contact between patient and health care provider the immunization was performed as part of.

lotNumber string? - Lot number of the vaccine product.

recorded dateTime? - The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.

contained Resource[]? - 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.

site CodeableConcept? - Body site where vaccine was administered.

route CodeableConcept? - The path by which the vaccine product is taken into the body.

protocolApplied ImmunizationProtocolApplied[]? - The protocol (set of recommendations) being followed by the provider who administered the dose.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

reportOrigin CodeableConcept? - The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.

location Reference? - The service delivery location where the vaccine administration occurred.

occurrenceDateTime dateTime - Date vaccine administered or was to be administered.

occurrenceString string - Date vaccine administered or was to be administered.

fundingSource CodeableConcept? - Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).

status ImmunizationStatus - Indicates the current status of the immunization event.

never... - Rest field

health.fhir.r4: ImmunizationEducation

Closed record

FHIR ImmunizationEducation datatype record.

Fields

reference uri? - Reference pointer to the educational material given to the patient if the information was on line.

extension Extension[]? - 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.

documentType string? - Identifier of the material presented to the patient.

modifierExtension Extension[]? - 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).

presentationDate dateTime? - Date the educational material was given to the patient.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

publicationDate dateTime? - Date the educational material was published.

health.fhir.r4: ImmunizationEvaluation

FHIR ImmunizationEvaluation resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_IMMUNIZATIONEVALUATION(default RESOURCE_NAME_IMMUNIZATIONEVALUATION) - The type of the resource describes

meta BaseImmunizationEvaluationMeta(default { profile : [PROFILE_BASE_IMMUNIZATIONEVALUATION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime? - The date the evaluation of the vaccine administration event was performed.

identifier Identifier[]? - A unique identifier assigned to this immunization evaluation record.

extension Extension[]? - 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.

seriesDosesPositiveInt positiveInt? - The recommended number of doses to achieve immunity.

doseStatus CodeableConcept - Indicates if the dose is valid or not valid with respect to the published recommendations.

modifierExtension Extension[]? - 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).

description string? - Additional information about the evaluation.

language code? - The base language in which the resource is written.

seriesDosesString string? - The recommended number of doses to achieve immunity.

immunizationEvent Reference - The vaccine administration event being evaluated.

doseNumberString string? - Nominal position in a series.

contained Resource[]? - 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.

doseStatusReason CodeableConcept[]? - Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.

patient Reference - The individual for whom the evaluation is being done.

series string? - One possible path to achieve presumed immunity against a disease - within the context of an authority.

authority Reference? - Indicates the authority who published the protocol (e.g. ACIP).

doseNumberPositiveInt positiveInt? - Nominal position in a series.

targetDisease CodeableConcept - The vaccine preventable disease the dose is being evaluated against.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

status ImmunizationEvaluationStatus - Indicates the current status of the evaluation of the vaccination administration event.

never... - Rest field

health.fhir.r4: ImmunizationPerformer

Closed record

FHIR ImmunizationPerformer datatype record.

Fields

actor Reference - The practitioner or organization who performed the action.

extension Extension[]? - 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.

'function CodeableConcept? - Describes the type of performance (e.g. ordering provider, administering provider, etc.).

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ImmunizationProtocolApplied

Closed record

FHIR ImmunizationProtocolApplied datatype record.

Fields

doseNumberString string - Nominal position in a series.

extension Extension[]? - 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.

seriesDosesPositiveInt positiveInt? - The recommended number of doses to achieve immunity.

series string? - One possible path to achieve presumed immunity against a disease - within the context of an authority.

authority Reference? - Indicates the authority who published the protocol (e.g. ACIP) that is being followed.

doseNumberPositiveInt positiveInt - Nominal position in a series.

modifierExtension Extension[]? - 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).

targetDisease CodeableConcept[]? - The vaccine preventable disease the dose is being administered against.

seriesDosesString string? - The recommended number of doses to achieve immunity.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ImmunizationReaction

Closed record

FHIR ImmunizationReaction datatype record.

Fields

date dateTime? - Date of reaction to the immunization.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

reported boolean? - Self-reported indicator.

detail Reference? - Details of the reaction.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ImmunizationRecommendation

FHIR ImmunizationRecommendation resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_IMMUNIZATIONRECOMMENDATION(default RESOURCE_NAME_IMMUNIZATIONRECOMMENDATION) - The type of the resource describes

meta BaseImmunizationRecommendationMeta(default { profile : [PROFILE_BASE_IMMUNIZATIONRECOMMENDATION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime - The date the immunization recommendation(s) were created.

identifier Identifier[]? - A unique identifier assigned to this particular recommendation record.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

recommendation ImmunizationRecommendationRecommendation[] - Vaccine administration recommendations.

language code? - The base language in which the resource is written.

contained Resource[]? - 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.

patient Reference - The patient the recommendation(s) are for.

authority Reference? - Indicates the authority who published the protocol (e.g. ACIP).

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

never... - Rest field

health.fhir.r4: ImmunizationRecommendationRecommendation

Closed record

FHIR ImmunizationRecommendationRecommendation datatype record.

Fields

supportingImmunization Reference[]? - Immunization event history and/or evaluation that supports the status and recommendation.

extension Extension[]? - 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.

forecastReason CodeableConcept[]? - The reason for the assigned forecast status.

seriesDosesPositiveInt positiveInt? - The recommended number of doses to achieve immunity.

modifierExtension Extension[]? - 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).

forecastStatus CodeableConcept - Indicates the patient status with respect to the path to immunity for the target disease.

description string? - Contains the description about the protocol under which the vaccine was administered.

seriesDosesString string? - The recommended number of doses to achieve immunity.

supportingPatientInformation Reference[]? - Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.

doseNumberString string? - Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose).

contraindicatedVaccineCode CodeableConcept[]? - Vaccine(s) which should not be used to fulfill the recommendation.

series string? - One possible path to achieve presumed immunity against a disease - within the context of an authority.

doseNumberPositiveInt positiveInt? - Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose).

targetDisease CodeableConcept? - The targeted disease for the recommendation.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

dateCriterion ImmunizationRecommendationRecommendationDateCriterion[]? - Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.

vaccineCode CodeableConcept[]? - Vaccine(s) or vaccine group that pertain to the recommendation.

health.fhir.r4: ImmunizationRecommendationRecommendationDateCriterion

Closed record

FHIR ImmunizationRecommendationRecommendationDateCriterion datatype record.

Fields

extension Extension[]? - 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.

code CodeableConcept - Date classification of recommendation. For example, earliest date to give, latest date to give, etc.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value dateTime - The date whose meaning is specified by dateCriterion.code.

health.fhir.r4: ImplementationGuide

FHIR ImplementationGuide resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_IMPLEMENTATIONGUIDE(default RESOURCE_NAME_IMPLEMENTATIONGUIDE) - The type of the resource describes

meta BaseImplementationGuideMeta(default { profile : [PROFILE_BASE_IMPLEMENTATIONGUIDE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime? - The date (and optionally time) when the implementation guide was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes.

copyright markdown? - A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide.

extension Extension[]? - 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.

jurisdiction CodeableConcept[]? - A legal or geographic region in which the implementation guide is intended to be used.

modifierExtension Extension[]? - 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).

description markdown? - A free text natural language description of the implementation guide from a consumer's perspective.

experimental boolean? - A Boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

global ImplementationGuideGlobal[]? - A set of profiles that all resources covered by this implementation guide must conform to.

language code? - The base language in which the resource is written.

title string? - A short, descriptive, user-friendly title for the implementation guide.

contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.

fhirVersion code[] - The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.1. for this version.

definition ImplementationGuideDefinition? - The information needed by an IG publisher tool to publish the whole implementation guide.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

dependsOn ImplementationGuideDependsOn[]? - Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.

manifest ImplementationGuideManifest? - Information about an assembled implementation guide, created by the publication tooling.

packageId id - The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care.

'version string? - The identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

url uri - An absolute URI that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this implementation guide is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the implementation guide is stored on different servers.

license code? - The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'.

contained Resource[]? - 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.

name string - A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher string? - The name of the organization or individual that published the implementation guide.

useContext UsageContext[]? - 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 implementation guide instances.

status ImplementationGuideStatus - The status of this implementation guide. Enables tracking the life-cycle of the content.

never... - Rest field

health.fhir.r4: ImplementationGuideDefinition

Closed record

FHIR ImplementationGuideDefinition datatype record.

Fields

template ImplementationGuideDefinitionTemplate[]? - A template for building resources.

extension Extension[]? - 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.

'resource ImplementationGuideDefinitionResource[] - A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.

modifierExtension Extension[]? - 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).

'parameter ImplementationGuideDefinitionParameter[]? - Defines how IG is built by tools.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

page ImplementationGuideDefinitionPage? - A page / section in the implementation guide. The root page is the implementation guide home page.

grouping ImplementationGuideDefinitionGrouping[]? - A logical group of resources. Logical groups can be used when building pages.

health.fhir.r4: ImplementationGuideDefinitionGrouping

Closed record

FHIR ImplementationGuideDefinitionGrouping datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

name string - The human-readable title to display for the package of resources when rendering the implementation guide.

description string? - Human readable text describing the package.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ImplementationGuideDefinitionPage

Closed record

FHIR ImplementationGuideDefinitionPage datatype record.

Fields

generation ImplementationGuideDefinitionPageGeneration - A code that indicates how the page is generated.

extension Extension[]? - 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.

nameReference Reference - The source address for the page.

nameUrl urlType - The source address for the page.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

title string - A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etc.

health.fhir.r4: ImplementationGuideDefinitionParameter

Closed record

FHIR ImplementationGuideDefinitionParameter datatype record.

Fields

extension Extension[]? - 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.

code ImplementationGuideDefinitionParameterCode - apply | path-resource | path-pages | path-tx-cache | expansion-parameter | rule-broken-links | generate-xml | generate-json | generate-turtle | html-template.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value string - Value for named type.

health.fhir.r4: ImplementationGuideDefinitionResource

Closed record

FHIR ImplementationGuideDefinitionResource datatype record.

Fields

reference Reference - Where this resource is found.

exampleCanonical canonical? - If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.

extension Extension[]? - 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.

groupingId id? - Reference to the id of the grouping this resource appears in.

fhirVersion code[]? - Indicates the FHIR Version(s) this artifact is intended to apply to. If no versions are specified, the resource is assumed to apply to all the versions stated in ImplementationGuide.fhirVersion.

modifierExtension Extension[]? - 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).

exampleBoolean boolean? - If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.

name string? - A human assigned name for the resource. All resources SHOULD have a name, but the name may be extracted from the resource (e.g. ValueSet.name).

description string? - A description of the reason that a resource has been included in the implementation guide.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ImplementationGuideDefinitionTemplate

Closed record

FHIR ImplementationGuideDefinitionTemplate datatype record.

Fields

extension Extension[]? - 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.

code code - Type of template specified.

modifierExtension Extension[]? - 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).

scope string? - The scope in which the template applies.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'source string - The source location for the template.

health.fhir.r4: ImplementationGuideDependsOn

Closed record

FHIR ImplementationGuideDependsOn datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

packageId id? - The NPM package name for the Implementation Guide that this IG depends on.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

uri canonical - A canonical reference to the Implementation guide for the dependency.

'version string? - The version of the IG that is depended on, when the correct version is required to understand the IG correctly.

health.fhir.r4: ImplementationGuideGlobal

Closed record

FHIR ImplementationGuideGlobal datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

profile canonical - A reference to the profile that all instances must conform to.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type code - The type of resource that all instances must conform to.

health.fhir.r4: ImplementationGuideManifest

Closed record

FHIR ImplementationGuideManifest datatype record.

Fields

image string[]? - Indicates a relative path to an image that exists within the IG.

extension Extension[]? - 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.

other string[]? - Indicates the relative path of an additional non-page, non-image file that is part of the IG - e.g. zip, jar and similar files that could be the target of a hyperlink in a derived IG.

'resource ImplementationGuideManifestResource[] - A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.

modifierExtension Extension[]? - 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).

rendering urlType? - A pointer to official web page, PDF or other rendering of the implementation guide.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

page ImplementationGuideManifestPage[]? - Information about a page within the IG.

health.fhir.r4: ImplementationGuideManifestPage

Closed record

FHIR ImplementationGuideManifestPage datatype record.

Fields

extension Extension[]? - 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.

anchor string[]? - The name of an anchor available on the page.

modifierExtension Extension[]? - 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).

name string - Relative path to the page.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

title string? - Label for the page intended for human display.

health.fhir.r4: ImplementationGuideManifestResource

Closed record

FHIR ImplementationGuideManifestResource datatype record.

Fields

reference Reference - Where this resource is found.

exampleCanonical canonical? - If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.

extension Extension[]? - 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.

relativePath urlType? - The relative path for primary page for this resource within the IG.

modifierExtension Extension[]? - 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).

exampleBoolean boolean? - If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: Information

Closed record

Information about a rest feature.

Fields

descriptionreadonly string - Description

builtinreadonly boolean? - Is this feature is available as a built-in feature

documentationreadonly string? - Documentation link

health.fhir.r4: InstantExtension

Closed record

Fields

url uri -

valueInstant instant -

health.fhir.r4: InsurancePlan

FHIR InsurancePlan resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_INSURANCEPLAN(default RESOURCE_NAME_INSURANCEPLAN) - The type of the resource describes

meta BaseInsurancePlanMeta(default { profile : [PROFILE_BASE_INSURANCEPLAN] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

coverage InsurancePlanCoverage[]? - Details about the coverage offered by the insurance product.

identifier Identifier[]? - Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server.

extension Extension[]? - 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.

period Period? - The period of time that the health insurance product is available.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

administeredBy Reference? - An organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner.

'type CodeableConcept[]? - The kind of health insurance product.

network Reference[]? - Reference to the network included in the health insurance product.

contained Resource[]? - 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.

endpoint Reference[]? - The technical endpoints providing access to services operated for the health insurance product.

contact InsurancePlanContact[]? - The contact for the health insurance product for a certain purpose.

name string? - Official name of the health insurance product as designated by the owner.

alias string[]? - A list of alternate names that the product is known as, or was known as in the past.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ownedBy Reference? - The entity that is providing the health insurance product and underwriting the risk. This is typically an insurance carriers, other third-party payers, or health plan sponsors comonly referred to as 'payers'.

plan InsurancePlanPlan[]? - Details about an insurance plan.

coverageArea Reference[]? - The geographic region in which a health insurance product's benefits apply.

status InsurancePlanStatus? - The current state of the health insurance product.

never... - Rest field

health.fhir.r4: InsurancePlanContact

Closed record

FHIR InsurancePlanContact datatype record.

Fields

extension Extension[]? - 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.

address Address? - Visiting or postal addresses for the contact.

purpose CodeableConcept? - Indicates a purpose for which the contact can be reached.

modifierExtension Extension[]? - 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).

name HumanName? - A name associated with the contact.

telecom ContactPoint[]? - A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: InsurancePlanCoverage

Closed record

FHIR InsurancePlanCoverage datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - Type of coverage (Medical; Dental; Mental Health; Substance Abuse; Vision; Drug; Short Term; Long Term Care; Hospice; Home Health).

benefit InsurancePlanCoverageBenefit[] - Specific benefits under this type of coverage.

network Reference[]? - Reference to the network that providing the type of coverage.

health.fhir.r4: InsurancePlanCoverageBenefit

Closed record

FHIR InsurancePlanCoverageBenefit datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

'limit InsurancePlanCoverageBenefitLimit[]? - The specific limits on the benefit.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

requirement string? - The referral requirements to have access/coverage for this benefit.

'type CodeableConcept - Type of benefit (primary care; speciality care; inpatient; outpatient).

health.fhir.r4: InsurancePlanCoverageBenefitLimit

Closed record

FHIR InsurancePlanCoverageBenefitLimit datatype record.

Fields

extension Extension[]? - 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.

code CodeableConcept? - The specific limit on the benefit.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value Quantity? - The maximum amount of a service item a plan will pay for a covered benefit. For examples. wellness visits, or eyeglasses.

health.fhir.r4: InsurancePlanPlan

Closed record

FHIR InsurancePlanPlan datatype record.

Fields

identifier Identifier[]? - Business identifiers assigned to this health insurance plan which remain constant as the resource is updated and propagates from server to server.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

specificCost InsurancePlanPlanSpecificCost[]? - Costs associated with the coverage provided by the product.

'type CodeableConcept? - Type of plan. For example, 'Platinum' or 'High Deductable'.

coverageArea Reference[]? - The geographic region in which a health insurance plan's benefits apply.

generalCost InsurancePlanPlanGeneralCost[]? - Overall costs associated with the plan.

network Reference[]? - Reference to the network that providing the type of coverage.

health.fhir.r4: InsurancePlanPlanGeneralCost

Closed record

FHIR InsurancePlanPlanGeneralCost datatype record.

Fields

extension Extension[]? - 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.

cost Money? - Value of the cost.

modifierExtension Extension[]? - 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).

comment string? - Additional information about the general costs associated with this plan.

groupSize positiveInt? - Number of participants enrolled in the plan.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept? - Type of cost.

health.fhir.r4: InsurancePlanPlanSpecificCost

Closed record

FHIR InsurancePlanPlanSpecificCost datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category CodeableConcept - General category of benefit (Medical; Dental; Vision; Drug; Mental Health; Substance Abuse; Hospice, Home Health).

benefit InsurancePlanPlanSpecificCostBenefit[]? - List of the specific benefits under this category of benefit.

health.fhir.r4: InsurancePlanPlanSpecificCostBenefit

Closed record

FHIR InsurancePlanPlanSpecificCostBenefit datatype record.

Fields

extension Extension[]? - 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.

cost InsurancePlanPlanSpecificCostBenefitCost[]? - List of the costs associated with a specific benefit.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - Type of specific benefit (preventative; primary care office visit; speciality office visit; hospitalization; emergency room; urgent care).

health.fhir.r4: InsurancePlanPlanSpecificCostBenefitCost

Closed record

FHIR InsurancePlanPlanSpecificCostBenefitCost datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

qualifiers CodeableConcept[]? - Additional information about the cost, such as information about funding sources (e.g. HSA, HRA, FSA, RRA).

applicability CodeableConcept? - Whether the cost applies to in-network or out-of-network providers (in-network; out-of-network; other).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - Type of cost (copay; individual cap; family cap; coinsurance; deductible).

value Quantity? - The actual cost value. (some of the costs may be represented as percentages rather than currency, e.g. 10% coinsurance).

health.fhir.r4: Integer64Extension

Closed record

Fields

url uri -

valueInteger64 integer64 -

health.fhir.r4: IntegerExtension

Closed record

Fields

url uri -

valueInteger integer -

health.fhir.r4: Invoice

FHIR Invoice resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_INVOICE(default RESOURCE_NAME_INVOICE) - The type of the resource describes

meta BaseInvoiceMeta(default { profile : [PROFILE_BASE_INVOICE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime? - Date/time(s) of when this Invoice was posted.

identifier Identifier[]? - Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments.

note Annotation[]? - Comments made about the invoice by the issuer, subject, or other participants.

totalGross Money? - Invoice total, tax included.

extension Extension[]? - 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.

subject Reference? - The individual or set of individuals receiving the goods and services billed in this invoice.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

'type CodeableConcept? - Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary).

issuer Reference? - The organizationissuing the Invoice.

participant InvoiceParticipant[]? - Indicates who or what performed or participated in the charged service.

totalNet Money? - Invoice total , taxes excluded.

contained Resource[]? - 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.

lineItem InvoiceLineItem[]? - Each line item represents one charge for goods and services rendered. Details such as date, code and amount are found in the referenced ChargeItem resource.

recipient Reference? - The individual or Organization responsible for balancing of this invoice.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

cancelledReason string? - In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.).

account Reference? - Account which is supposed to be balanced with this Invoice.

paymentTerms markdown? - Payment details such as banking details, period of payment, deductibles, methods of payment.

status InvoiceStatus - The current state of the Invoice.

never... - Rest field

health.fhir.r4: InvoiceLineItem

Closed record

FHIR InvoiceLineItem datatype record.

Fields

chargeItemCodeableConcept CodeableConcept - The ChargeItem contains information such as the billing code, date, amount etc. If no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference.

sequence positiveInt? - Sequence in which the items appear on the invoice.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

priceComponent InvoiceLineItemPriceComponent[]? - The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice as to how the prices have been calculated.

chargeItemReference Reference - The ChargeItem contains information such as the billing code, date, amount etc. If no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference.

health.fhir.r4: InvoiceLineItemPriceComponent

Closed record

FHIR InvoiceLineItemPriceComponent datatype record.

Fields

amount Money? - The amount calculated for this component.

extension Extension[]? - 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.

code CodeableConcept? - A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

factor decimal? - The factor that has been applied on the base price for calculating this component.

'type InvoiceLineItemPriceComponentType - This code identifies the type of the component.

health.fhir.r4: InvoiceParticipant

Closed record

FHIR InvoiceParticipant datatype record.

Fields

actor Reference - The device, practitioner, etc. who performed or participated in the service.

extension Extension[]? - 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.

role CodeableConcept? - Describes the type of involvement (e.g. transcriptionist, creator etc.). If the invoice has been created automatically, the Participant may be a billing engine or another kind of device.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: JWT

Record holding Decoded JWT content.

Fields

payload readonly & Payload - JWT payload

health.fhir.r4: Library

FHIR Library resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_LIBRARY(default RESOURCE_NAME_LIBRARY) - The type of the resource describes

meta BaseLibraryMeta(default { profile : [PROFILE_BASE_LIBRARY] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime? - The date (and optionally time) when the library was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes.

copyright markdown? - A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library.

extension Extension[]? - 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.

approvalDate date? - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

subjectCodeableConcept CodeableConcept? - A code or group definition that describes the intended subject of the contents of the library.

purpose markdown? - Explanation of why this library is needed and why it has been designed as it has.

jurisdiction CodeableConcept[]? - A legal or geographic region in which the library is intended to be used.

modifierExtension Extension[]? - 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).

usage string? - A detailed description of how the library is used from a clinical perspective.

description markdown? - A free text natural language description of the library from a consumer's perspective.

experimental boolean? - A Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language code? - The base language in which the resource is written.

title string? - A short, descriptive, user-friendly title for the library.

'type CodeableConcept - Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.

content Attachment[]? - The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.

contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.

'parameter ParameterDefinition[]? - The parameter element defines parameters used by the library.

endorser ContactDetail[]? - An individual or organization responsible for officially endorsing the content for use in some setting.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

editor ContactDetail[]? - An individual or organization primarily responsible for internal coherence of the content.

identifier Identifier[]? - A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.

relatedArtifact RelatedArtifact[]? - Related artifacts such as additional documentation, justification, or bibliographic references.

effectivePeriod Period? - The period during which the library content was or is planned to be in active use.

author ContactDetail[]? - An individiual or organization primarily involved in the creation and maintenance of the content.

reviewer ContactDetail[]? - An individual or organization primarily responsible for review of some aspect of the content.

subjectReference Reference? - A code or group definition that describes the intended subject of the contents of the library.

'version string? - The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.

url uri? - An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers.

contained Resource[]? - 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.

lastReviewDate date? - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

subtitle string? - An explanatory or alternate title for the library giving additional information about its content.

name string? - A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation.

dataRequirement DataRequirement[]? - Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher string? - The name of the organization or individual that published the library.

topic CodeableConcept[]? - Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching.

useContext UsageContext[]? - 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 library instances.

status LibraryStatus - The status of this library. Enables tracking the life-cycle of the content.

never... - Rest field

health.fhir.r4: Linkage

FHIR Linkage resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_LINKAGE(default RESOURCE_NAME_LINKAGE) - The type of the resource describes

meta BaseLinkageMeta(default { profile : [PROFILE_BASE_LINKAGE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

contained Resource[]? - 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.

extension Extension[]? - 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.

item LinkageItem[] - Identifies which record considered as the reference to the same real-world occurrence as well as how the items should be evaluated within the collection of linked items.

author Reference? - Identifies the user or organization responsible for asserting the linkages as well as the user or organization who establishes the context in which the nature of each linkage is evaluated.

modifierExtension Extension[]? - 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).

active boolean? - Indicates whether the asserted set of linkages are considered to be 'in effect'.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

language code? - The base language in which the resource is written.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

never... - Rest field

health.fhir.r4: LinkageItem

Closed record

FHIR LinkageItem datatype record.

Fields

extension Extension[]? - 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.

'resource Reference - The resource instance being linked as part of the group.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type LinkageItemType - Distinguishes which item is 'source of truth' (if any) and which items are no longer considered to be current representations.

health.fhir.r4: List

FHIR List resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_LIST(default RESOURCE_NAME_LIST) - The type of the resource describes

meta BaseListMeta(default { profile : [PROFILE_BASE_LIST] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime? - The date that the list was prepared.

identifier Identifier[]? - Identifier for the List assigned for business purposes outside the context of FHIR.

note Annotation[]? - Comments that apply to the overall list.

extension Extension[]? - 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.

code CodeableConcept? - This code defines the purpose of the list - why it was created.

emptyReason CodeableConcept? - If the list is empty, why the list is empty.

subject Reference? - The common subject (or patient) of the resources that are in the list if there is one.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

encounter Reference? - The encounter that is the context in which this list was created.

'source Reference? - The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.

title string? - A label for the list assigned by the author.

mode ListMode - How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

entry ListEntry[]? - Entries in this list.

contained Resource[]? - 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.

orderedBy CodeableConcept? - What order applies to the items in the list.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

status ListStatus - Indicates the current state of this list.

never... - Rest field

health.fhir.r4: ListEntry

Closed record

FHIR ListEntry datatype record.

Fields

date dateTime? - When this item was added to the list.

extension Extension[]? - 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.

item Reference - A reference to the actual resource from which data was derived.

deleted boolean? - True if this item is marked as deleted in the list.

flag CodeableConcept? - The flag allows the system constructing the list to indicate the role and significance of the item in the list.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: Location

FHIR Location resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_LOCATION(default RESOURCE_NAME_LOCATION) - The type of the resource describes

meta BaseLocationMeta(default { profile : [PROFILE_BASE_LOCATION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

operationalStatus Coding? - The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.

partOf Reference? - Another Location of which this Location is physically a part of.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

description string? - Description of the Location, which helps in finding or referencing the place.

hoursOfOperation LocationHoursOfOperation[]? - What days/times during a week is this location usually open.

language code? - The base language in which the resource is written.

'type CodeableConcept[]? - Indicates the type of function performed at the location.

mode LocationMode? - Indicates whether a resource instance represents a specific location or a class of locations.

endpoint Reference[]? - Technical endpoints providing access to services operated for the location.

alias string[]? - A list of alternate names that the location is known as, or was known as, in the past.

telecom ContactPoint[]? - The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

identifier Identifier[]? - Unique code or number identifying the location to its users.

address Address? - Physical location.

physicalType CodeableConcept? - Physical form of the location, e.g. building, room, vehicle, road.

contained Resource[]? - 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.

managingOrganization Reference? - The organization responsible for the provisioning and upkeep of the location.

name string? - Name of the location as used by humans. Does not need to be unique.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

position LocationPosition? - The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).

availabilityExceptions string? - A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.

status LocationStatus? - The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.

never... - Rest field

health.fhir.r4: LocationHoursOfOperation

Closed record

FHIR LocationHoursOfOperation datatype record.

Fields

allDay boolean? - The Location is open all day.

extension Extension[]? - 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.

closingTime time? - Time that the Location closes.

modifierExtension Extension[]? - 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).

openingTime time? - Time that the Location opens.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

daysOfWeek LocationHoursOfOperationDaysOfWeek[]? - Indicates which days of the week are available between the start and end Times.

health.fhir.r4: LocationPosition

Closed record

FHIR LocationPosition datatype record.

Fields

altitude decimal? - Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).

extension Extension[]? - 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.

latitude decimal - Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

longitude decimal - Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).

health.fhir.r4: Mapping

Record type to hold relocation mapping information.

Fields

sourcePath string - FHIR path to source

targetPath string - FHIR path to target location

health.fhir.r4: MarkdownExtension

Closed record

Fields

url uri -

valueMarkdown markdown -

health.fhir.r4: MarketingStatus

Closed record

The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.

Fields

Fields Included from *BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

modifierExtension Extension[]? - Additional content defined by implementations

country CodeableConcept? - The country in which the marketing authorisation has been granted shall be specified It should be specified using the ISO 3166 ‑ 1 alpha-2 code elements

jurisdiction CodeableConcept? - "Where a Medicines Regulatory Agency has granted a marketing authorisation for which specific provisions within a jurisdiction apply, the jurisdiction can be specified using an appropriate controlled terminology The controlled term and the controlled term identifier shall be specified

status CodeableConcept - This attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples

dateRange Period? - The date when the Medicinal Product is placed on the market by the Marketing Authorisation Holder " +(or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market refers to the release of the Medicinal Product into the distribution chain

restoreDate dateTime? - The date when the Medicinal Product is placed on the market by the Marketing Authorisation Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain

health.fhir.r4: Measure

FHIR Measure resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_MEASURE(default RESOURCE_NAME_MEASURE) - The type of the resource describes

meta BaseMeasureMeta(default { profile : [PROFILE_BASE_MEASURE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime? - The date (and optionally time) when the measure was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the measure changes.

copyright markdown? - A copyright statement relating to the measure and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the measure.

modifierExtension Extension[]? - 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).

usage string? - A detailed description, from a clinical perspective, of how the measure is used.

experimental boolean? - A Boolean value to indicate that this measure is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language code? - The base language in which the resource is written.

'type CodeableConcept[]? - Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization.

riskAdjustment string? - A description of the risk adjustment factors that may impact the resulting score for the measure and how they may be accounted for when computing and reporting measure results.

contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.

endorser ContactDetail[]? - An individual or organization responsible for officially endorsing the content for use in some setting.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

group MeasureGroup[]? - A group of population criteria for the measure.

identifier Identifier[]? - A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance.

relatedArtifact RelatedArtifact[]? - Related artifacts such as additional documentation, justification, or bibliographic references.

effectivePeriod Period? - The period during which the measure content was or is planned to be in active use.

rateAggregation string? - Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result.

author ContactDetail[]? - An individiual or organization primarily involved in the creation and maintenance of the content.

compositeScoring CodeableConcept? - If this is a composite measure, the scoring method used to combine the component measures to determine the composite score.

supplementalData MeasureSupplementalData[]? - The supplemental data criteria for the measure report, specified as either the name of a valid CQL expression within a referenced library, or a valid FHIR Resource Path.

'version string? - The identifier that is used to identify this version of the measure when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the measure author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.

lastReviewDate date? - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

subtitle string? - An explanatory or alternate title for the measure giving additional information about its content.

name string? - A natural language name identifying the measure. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher string? - The name of the organization or individual that published the measure.

topic CodeableConcept[]? - Descriptive topics related to the content of the measure. Topics provide a high-level categorization grouping types of measures that can be useful for filtering and searching.

useContext UsageContext[]? - 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 measure instances.

status MeasureStatus - The status of this measure. Enables tracking the life-cycle of the content.

clinicalRecommendationStatement markdown? - Provides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.

extension Extension[]? - 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.

approvalDate date? - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

subjectCodeableConcept CodeableConcept? - The intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything.

purpose markdown? - Explanation of why this measure is needed and why it has been designed as it has.

jurisdiction CodeableConcept[]? - A legal or geographic region in which the measure is intended to be used.

description markdown? - A free text natural language description of the measure from a consumer's perspective.

improvementNotation CodeableConcept? - Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range).

title string? - A short, descriptive, user-friendly title for the measure.

library canonical[]? - A reference to a Library resource containing the formal logic used by the measure.

definition markdown[]? - Provides a description of an individual term used within the measure.

disclaimer markdown? - Notices and disclaimers regarding the use of the measure or related to intellectual property (such as code systems) referenced by the measure.

editor ContactDetail[]? - An individual or organization primarily responsible for internal coherence of the content.

scoring CodeableConcept? - Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented.

reviewer ContactDetail[]? - An individual or organization primarily responsible for review of some aspect of the content.

rationale markdown? - Provides a succinct statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.

subjectReference Reference? - The intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything.

url uri? - An absolute URI that is used to identify this measure when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this measure is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the measure is stored on different servers.

contained Resource[]? - 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.

guidance markdown? - Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.

never... - Rest field

health.fhir.r4: MeasureGroup

Closed record

FHIR MeasureGroup datatype record.

Fields

extension Extension[]? - 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.

code CodeableConcept? - Indicates a meaning for the group. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing groups to be correlated across measures.

modifierExtension Extension[]? - 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).

description string? - The human readable description of this population group.

stratifier MeasureGroupStratifier[]? - The stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

population MeasureGroupPopulation[]? - A population criteria for the measure.

health.fhir.r4: MeasureGroupPopulation

Closed record

FHIR MeasureGroupPopulation datatype record.

Fields

extension Extension[]? - 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.

code CodeableConcept? - The type of population criteria.

criteria Expression - An expression that specifies the criteria for the population, typically the name of an expression in a library.

modifierExtension Extension[]? - 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).

description string? - The human readable description of this population criteria.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: MeasureGroupStratifier

Closed record

FHIR MeasureGroupStratifier datatype record.

Fields

component MeasureGroupStratifierComponent[]? - A component of the stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.

extension Extension[]? - 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.

code CodeableConcept? - Indicates a meaning for the stratifier. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing stratifiers to be correlated across measures.

criteria Expression? - An expression that specifies the criteria for the stratifier. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element.

modifierExtension Extension[]? - 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).

description string? - The human readable description of this stratifier criteria.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: MeasureGroupStratifierComponent

Closed record

FHIR MeasureGroupStratifierComponent datatype record.

Fields

extension Extension[]? - 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.

code CodeableConcept? - Indicates a meaning for the stratifier component. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing stratifiers to be correlated across measures.

criteria Expression - An expression that specifies the criteria for this component of the stratifier. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element.

modifierExtension Extension[]? - 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).

description string? - The human readable description of this stratifier criteria component.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: MeasureReport

FHIR MeasureReport resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_MEASUREREPORT(default RESOURCE_NAME_MEASUREREPORT) - The type of the resource describes

meta BaseMeasureReportMeta(default { profile : [PROFILE_BASE_MEASUREREPORT] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime? - The date this measure report was generated.

identifier Identifier[]? - A formal identifier that is used to identify this MeasureReport when it is represented in other formats or referenced in a specification, model, design or an instance.

extension Extension[]? - 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.

period Period - The reporting period for which the report was calculated.

subject Reference? - Optional subject identifying the individual or individuals the report is for.

modifierExtension Extension[]? - 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).

improvementNotation CodeableConcept? - Whether improvement in the measure is noted by an increase or decrease in the measure score.

language code? - The base language in which the resource is written.

reporter Reference? - The individual, location, or organization that is reporting the data.

'type MeasureReportType - The type of measure report. This may be an individual report, which provides the score for the measure for an individual member of the population; a subject-listing, which returns the list of members that meet the various criteria in the measure; a summary report, which returns a population count for each of the criteria in the measure; or a data-collection, which enables the MeasureReport to be used to exchange the data-of-interest for a quality measure.

contained Resource[]? - 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.

measure canonical - A reference to the Measure that was calculated to produce this report.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

evaluatedResource Reference[]? - A reference to a Bundle containing the Resources that were used in the calculation of this measure.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

group MeasureReportGroup[]? - The results of the calculation, one for each population group in the measure.

status MeasureReportStatus - The MeasureReport status. No data will be available until the MeasureReport status is complete.

never... - Rest field

health.fhir.r4: MeasureReportGroup

Closed record

FHIR MeasureReportGroup datatype record.

Fields

extension Extension[]? - 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.

code CodeableConcept? - The meaning of the population group as defined in the measure definition.

modifierExtension Extension[]? - 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).

stratifier MeasureReportGroupStratifier[]? - When a measure includes multiple stratifiers, there will be a stratifier group for each stratifier defined by the measure.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

measureScore Quantity? - The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group.

population MeasureReportGroupPopulation[]? - The populations that make up the population group, one for each type of population appropriate for the measure.

health.fhir.r4: MeasureReportGroupPopulation

Closed record

FHIR MeasureReportGroupPopulation datatype record.

Fields

extension Extension[]? - 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.

code CodeableConcept? - The type of the population.

modifierExtension Extension[]? - 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).

count integer? - The number of members of the population.

subjectResults Reference? - This element refers to a List of subject level MeasureReport resources, one for each subject in this population.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: MeasureReportGroupStratifier

Closed record

FHIR MeasureReportGroupStratifier datatype record.

Fields

extension Extension[]? - 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.

code CodeableConcept[]? - The meaning of this stratifier, as defined in the measure definition.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

stratum MeasureReportGroupStratifierStratum[]? - This element contains the results for a single stratum within the stratifier. For example, when stratifying on administrative gender, there will be four strata, one for each possible gender value.

health.fhir.r4: MeasureReportGroupStratifierStratum

Closed record

FHIR MeasureReportGroupStratifierStratum datatype record.

Fields

component MeasureReportGroupStratifierStratumComponent[]? - A stratifier component value.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

measureScore Quantity? - The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum.

value CodeableConcept? - The value for this stratum, expressed as a CodeableConcept. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is unique.

population MeasureReportGroupStratifierStratumPopulation[]? - The populations that make up the stratum, one for each type of population appropriate to the measure.

health.fhir.r4: MeasureReportGroupStratifierStratumComponent

Closed record

FHIR MeasureReportGroupStratifierStratumComponent datatype record.

Fields

extension Extension[]? - 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.

code CodeableConcept - The code for the stratum component value.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value CodeableConcept - The stratum component value.

health.fhir.r4: MeasureReportGroupStratifierStratumPopulation

Closed record

FHIR MeasureReportGroupStratifierStratumPopulation datatype record.

Fields

extension Extension[]? - 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.

code CodeableConcept? - The type of the population.

modifierExtension Extension[]? - 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).

count integer? - The number of members of the population in this stratum.

subjectResults Reference? - This element refers to a List of subject level MeasureReport resources, one for each subject in this population in this stratum.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: MeasureSupplementalData

Closed record

FHIR MeasureSupplementalData datatype record.

Fields

extension Extension[]? - 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.

code CodeableConcept? - Indicates a meaning for the supplemental data. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing supplemental data to be correlated across measures.

criteria Expression - The criteria for the supplemental data. This is typically the name of a valid expression defined within a referenced library, but it may also be a path to a specific data element. The criteria defines the data to be returned for this element.

modifierExtension Extension[]? - 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).

usage CodeableConcept[]? - An indicator of the intended usage for the supplemental data element. Supplemental data indicates the data is additional information requested to augment the measure information. Risk adjustment factor indicates the data is additional information used to calculate risk adjustment factors when applying a risk model to the measure calculation.

description string? - The human readable description of this supplemental data.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: Media

FHIR Media resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_MEDIA(default RESOURCE_NAME_MEDIA) - The type of the resource describes

meta BaseMediaMeta(default { profile : [PROFILE_BASE_MEDIA] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

note Annotation[]? - Comments made about the media by the performer, subject or other participants.

partOf Reference[]? - A larger event of which this particular event is a component or step.

extension Extension[]? - 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.

modality CodeableConcept? - Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality.

subject Reference? - Who/What this Media is a record of.

modifierExtension Extension[]? - 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).

createdDateTime dateTime? - The date and time(s) at which the media was collected.

language code? - The base language in which the resource is written.

'type CodeableConcept? - A code that classifies whether the media is an image, video or audio recording or some other media category.

deviceName string? - The name of the device / manufacturer of the device that was used to make the recording.

content Attachment - The actual content of the media - inline or by direct reference to the media source file.

operator Reference? - The person who administered the collection of the image.

duration decimal? - The duration of the recording in seconds - for audio and video.

view CodeableConcept? - The name of the imaging view e.g. Lateral or Antero-posterior (AP).

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

reasonCode CodeableConcept[]? - Describes why the event occurred in coded or textual form.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time this version of the media was made available to providers, typically after having been reviewed.

basedOn Reference[]? - A procedure that is fulfilled in whole or in part by the creation of this media.

height positiveInt? - Height of the image in pixels (photo/video).

identifier Identifier[]? - Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers.

frames positiveInt? - The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.

encounter Reference? - The encounter that establishes the context for this media.

createdPeriod Period? - The date and time(s) at which the media was collected.

bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).

contained Resource[]? - 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.

width positiveInt? - Width of the image in pixels (photo/video).

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

device Reference? - The device used to collect the media.

status MediaStatus - The current state of the {{title}}.

never... - Rest field

health.fhir.r4: Medication

FHIR Medication resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_MEDICATION(default RESOURCE_NAME_MEDICATION) - The type of the resource describes

meta BaseMedicationMeta(default { profile : [PROFILE_BASE_MEDICATION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

identifier Identifier[]? - Business identifier for this medication.

amount Ratio? - Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).

extension Extension[]? - 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.

code CodeableConcept? - A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.

ingredient MedicationIngredient[]? - Identifies a particular constituent of interest in the product.

modifierExtension Extension[]? - 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).

batch MedicationBatch? - Information that only applies to packages (not products).

language code? - The base language in which the resource is written.

manufacturer Reference? - Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.

contained Resource[]? - 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.

form CodeableConcept? - Describes the form of the item. Powder; tablets; capsule.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

status MedicationStatus? - A code to indicate if the medication is in active use.

never... - Rest field

health.fhir.r4: MedicationAdministration

FHIR MedicationAdministration resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_MEDICATIONADMINISTRATION(default RESOURCE_NAME_MEDICATIONADMINISTRATION) - The type of the resource describes

meta BaseMedicationAdministrationMeta(default { profile : [PROFILE_BASE_MEDICATIONADMINISTRATION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

dosage MedicationAdministrationDosage? - Describes the medication dosage information details e.g. dose, rate, site, route, etc.

instantiates uri[]? - A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.

note Annotation[]? - Extra information about the medication administration that is not conveyed by the other attributes.

partOf Reference[]? - A larger event of which this particular event is a component or step.

request Reference? - The original request, instruction or authority to perform the administration.

extension Extension[]? - 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.

subject Reference - The person or animal or group receiving the medication.

modifierExtension Extension[]? - 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).

reasonReference Reference[]? - Condition or observation that supports why the medication was administered.

language code? - The base language in which the resource is written.

medicationReference Reference - Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.

statusReason CodeableConcept[]? - A code indicating why the administration was not performed.

context Reference? - The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

reasonCode CodeableConcept[]? - A code indicating why the medication was given.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

identifier Identifier[]? - Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.

performer MedicationAdministrationPerformer[]? - Indicates who or what performed the medication administration and how they were involved.

effectivePeriod Period - A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.

supportingInformation Reference[]? - Additional information (for example, patient height and weight) that supports the administration of the medication.

medicationCodeableConcept CodeableConcept - Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.

contained Resource[]? - 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.

effectiveDateTime dateTime - A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.

eventHistory Reference[]? - A summary of the events of interest that have occurred, such as when the administration was verified.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept? - Indicates where the medication is expected to be consumed or administered.

device Reference[]? - The device used in administering the medication to the patient. For example, a particular infusion pump.

status MedicationAdministrationStatus - Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.

never... - Rest field

health.fhir.r4: MedicationAdministrationDosage

Closed record

FHIR MedicationAdministrationDosage datatype record.

Fields

dose Quantity? - The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.

extension Extension[]? - 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.

rateRatio Ratio? - Identifies the speed with which the medication was or will be introduced into the patient. Typically, the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time, e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.

site CodeableConcept? - A coded specification of the anatomic site where the medication first entered the body. For example, 'left arm'.

route CodeableConcept? - A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.

method CodeableConcept? - A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV.

rateQuantity Quantity? - Identifies the speed with which the medication was or will be introduced into the patient. Typically, the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time, e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans. The dosage instructions should reflect the dosage of the medication that was administered.

health.fhir.r4: MedicationAdministrationPerformer

Closed record

FHIR MedicationAdministrationPerformer datatype record.

Fields

actor Reference - Indicates who or what performed the medication administration.

extension Extension[]? - 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.

'function CodeableConcept? - Distinguishes the type of involvement of the performer in the medication administration.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: MedicationBatch

Closed record

FHIR MedicationBatch datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

lotNumber string? - The assigned lot number of a batch of the specified product.

expirationDate dateTime? - When this specific batch of product will expire.

health.fhir.r4: MedicationDispense

FHIR MedicationDispense resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_MEDICATIONDISPENSE(default RESOURCE_NAME_MEDICATIONDISPENSE) - The type of the resource describes

meta BaseMedicationDispenseMeta(default { profile : [PROFILE_BASE_MEDICATIONDISPENSE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

note Annotation[]? - Extra information about the dispense that could not be conveyed in the other attributes.

partOf Reference[]? - The procedure that trigger the dispense.

extension Extension[]? - 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.

substitution MedicationDispenseSubstitution? - Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.

subject Reference? - A link to a resource representing the person or the group to whom the medication will be given.

modifierExtension Extension[]? - 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).

destination Reference? - Identification of the facility/location where the medication was shipped to, as part of the dispense event.

language code? - The base language in which the resource is written.

statusReasonReference Reference? - Indicates the reason why a dispense was not performed.

statusReasonCodeableConcept CodeableConcept? - Indicates the reason why a dispense was not performed.

'type CodeableConcept? - Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

medicationReference Reference - Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.

context Reference? - The encounter or episode of care that establishes the context for this event.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

authorizingPrescription Reference[]? - Indicates the medication order that is being dispensed against.

identifier Identifier[]? - Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.

performer MedicationDispensePerformer[]? - Indicates who or what performed the event.

quantity Quantity? - The amount of medication that has been dispensed. Includes unit of measure.

detectedIssue Reference[]? - Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug-drug interaction, duplicate therapy, dosage alert etc.

receiver Reference[]? - Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.

whenPrepared dateTime? - The time when the dispensed product was packaged and reviewed.

daysSupply Quantity? - The amount of medication expressed as a timing amount.

supportingInformation Reference[]? - Additional information that supports the medication being dispensed.

whenHandedOver dateTime? - The time the dispensed product was provided to the patient or their representative.

medicationCodeableConcept CodeableConcept - Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.

contained Resource[]? - 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.

dosageInstruction Dosage[]? - Indicates how the medication is to be used by the patient.

eventHistory Reference[]? - A summary of the events of interest that have occurred, such as when the dispense was verified.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

location Reference? - The principal physical location where the dispense was performed.

category CodeableConcept? - Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).

status MedicationDispenseStatus - A code specifying the state of the set of dispense events.

never... - Rest field

health.fhir.r4: MedicationDispensePerformer

Closed record

FHIR MedicationDispensePerformer datatype record.

Fields

actor Reference - The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication.

extension Extension[]? - 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.

'function CodeableConcept? - Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: MedicationDispenseSubstitution

Closed record

FHIR MedicationDispenseSubstitution datatype record.

Fields

reason CodeableConcept[]? - Indicates the reason for the substitution (or lack of substitution) from what was prescribed.

extension Extension[]? - 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.

wasSubstituted boolean - True if the dispenser dispensed a different drug or product from what was prescribed.

modifierExtension Extension[]? - 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).

responsibleParty Reference[]? - The person or organization that has primary responsibility for the substitution.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept? - A code signifying whether a different drug was dispensed from what was prescribed.

health.fhir.r4: MedicationIngredient

Closed record

FHIR MedicationIngredient datatype record.

Fields

itemReference Reference - The actual ingredient - either a substance (simple ingredient) or another medication of a medication.

extension Extension[]? - 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.

strength Ratio? - Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.

itemCodeableConcept CodeableConcept - The actual ingredient - either a substance (simple ingredient) or another medication of a medication.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

isActive boolean? - Indication of whether this ingredient affects the therapeutic action of the drug.

health.fhir.r4: MedicationKnowledge

FHIR MedicationKnowledge resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_MEDICATIONKNOWLEDGE(default RESOURCE_NAME_MEDICATIONKNOWLEDGE) - The type of the resource describes

meta BaseMedicationKnowledgeMeta(default { profile : [PROFILE_BASE_MEDICATIONKNOWLEDGE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

extension Extension[]? - 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.

code CodeableConcept? - A code that specifies this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.

modifierExtension Extension[]? - 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).

regulatory MedicationKnowledgeRegulatory[]? - Regulatory information about a medication.

medicineClassification MedicationKnowledgeMedicineClassification[]? - Categorization of the medication within a formulary or classification system.

associatedMedication Reference[]? - Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor).

language code? - The base language in which the resource is written.

manufacturer Reference? - Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.

synonym string[]? - Additional names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

relatedMedicationKnowledge MedicationKnowledgeRelatedMedicationKnowledge[]? - Associated or related knowledge about a medication.

productType CodeableConcept[]? - Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).

administrationGuidelines MedicationKnowledgeAdministrationGuidelines[]? - Guidelines for the administration of the medication.

contraindication Reference[]? - Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).

amount Quantity? - Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).

intendedRoute CodeableConcept[]? - The intended or approved route of administration.

cost MedicationKnowledgeCost[]? - The price of the medication.

ingredient MedicationKnowledgeIngredient[]? - Identifies a particular constituent of interest in the product.

preparationInstruction markdown? - The instructions for preparing the medication.

packaging MedicationKnowledgePackaging? - Information that only applies to packages (not products).

monitoringProgram MedicationKnowledgeMonitoringProgram[]? - The program under which the medication is reviewed.

contained Resource[]? - 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.

drugCharacteristic MedicationKnowledgeDrugCharacteristic[]? - Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.

doseForm CodeableConcept? - Describes the form of the item. Powder; tablets; capsule.

monograph MedicationKnowledgeMonograph[]? - Associated documentation about the medication.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

kinetics MedicationKnowledgeKinetics[]? - The time course of drug absorption, distribution, metabolism and excretion of a medication from the body.

status MedicationKnowledgeStatus? - A code to indicate if the medication is in active use. The status refers to the validity about the information of the medication and not to its medicinal properties.

never... - Rest field

health.fhir.r4: MedicationKnowledgeAdministrationGuidelines

Closed record

FHIR MedicationKnowledgeAdministrationGuidelines datatype record.

Fields

dosage MedicationKnowledgeAdministrationGuidelinesDosage[]? - Dosage for the medication for the specific guidelines.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

indicationReference Reference? - Indication for use that apply to the specific administration guidelines.

patientCharacteristics MedicationKnowledgeAdministrationGuidelinesPatientCharacteristics[]? - Characteristics of the patient that are relevant to the administration guidelines (for example, height, weight, gender, etc.).

indicationCodeableConcept CodeableConcept? - Indication for use that apply to the specific administration guidelines.

health.fhir.r4: MedicationKnowledgeAdministrationGuidelinesDosage

Closed record

FHIR MedicationKnowledgeAdministrationGuidelinesDosage datatype record.

Fields

dosage Dosage[] - Dosage for the medication for the specific guidelines.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - The type of dosage (for example, prophylaxis, maintenance, therapeutic, etc.).

health.fhir.r4: MedicationKnowledgeAdministrationGuidelinesPatientCharacteristics

Closed record

FHIR MedicationKnowledgeAdministrationGuidelinesPatientCharacteristics datatype record.

Fields

characteristicQuantity Quantity - Specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender).

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value string[]? - The specific characteristic (e.g. height, weight, gender, etc.).

characteristicCodeableConcept CodeableConcept - Specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender).

health.fhir.r4: MedicationKnowledgeCost

Closed record

FHIR MedicationKnowledgeCost datatype record.

Fields

extension Extension[]? - 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.

cost Money - The price of the medication.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'source string? - The source or owner that assigns the price to the medication.

'type CodeableConcept - The category of the cost information. For example, manufacturers' cost, patient cost, claim reimbursement cost, actual acquisition cost.

health.fhir.r4: MedicationKnowledgeDrugCharacteristic

Closed record

FHIR MedicationKnowledgeDrugCharacteristic datatype record.

Fields

valueCodeableConcept CodeableConcept? - Description of the characteristic.

valueBase64Binary base64Binary? - Description of the characteristic.

extension Extension[]? - 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.

valueString string? - Description of the characteristic.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept? - A code specifying which characteristic of the medicine is being described (for example, colour, shape, imprint).

valueQuantity Quantity? - Description of the characteristic.

health.fhir.r4: MedicationKnowledgeIngredient

Closed record

FHIR MedicationKnowledgeIngredient datatype record.

Fields

itemReference Reference - The actual ingredient - either a substance (simple ingredient) or another medication.

extension Extension[]? - 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.

strength Ratio? - Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.

itemCodeableConcept CodeableConcept - The actual ingredient - either a substance (simple ingredient) or another medication.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

isActive boolean? - Indication of whether this ingredient affects the therapeutic action of the drug.

health.fhir.r4: MedicationKnowledgeKinetics

Closed record

FHIR MedicationKnowledgeKinetics datatype record.

Fields

areaUnderCurve Quantity[]? - The drug concentration measured at certain discrete points in time.

extension Extension[]? - 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.

halfLifePeriod Duration? - The time required for any specified property (e.g., the concentration of a substance in the body) to decrease by half.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

lethalDose50 Quantity[]? - The median lethal dose of a drug.

health.fhir.r4: MedicationKnowledgeMedicineClassification

Closed record

FHIR MedicationKnowledgeMedicineClassification datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

classification CodeableConcept[]? - Specific category assigned to the medication (e.g. anti-infective, anti-hypertensive, antibiotic, etc.).

'type CodeableConcept - The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification).

health.fhir.r4: MedicationKnowledgeMonitoringProgram

Closed record

FHIR MedicationKnowledgeMonitoringProgram datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

name string? - Name of the reviewing program.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept? - Type of program under which the medication is monitored.

health.fhir.r4: MedicationKnowledgeMonograph

Closed record

FHIR MedicationKnowledgeMonograph datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'source Reference? - Associated documentation about the medication.

'type CodeableConcept? - The category of documentation about the medication. (e.g. professional monograph, patient education monograph).

health.fhir.r4: MedicationKnowledgePackaging

Closed record

FHIR MedicationKnowledgePackaging datatype record.

Fields

extension Extension[]? - 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.

quantity Quantity? - The number of product units the package would contain if fully loaded.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept? - A code that defines the specific type of packaging that the medication can be found in (e.g. blister sleeve, tube, bottle).

health.fhir.r4: MedicationKnowledgeRegulatory

Closed record

FHIR MedicationKnowledgeRegulatory datatype record.

Fields

schedule MedicationKnowledgeRegulatorySchedule[]? - Specifies the schedule of a medication in jurisdiction.

extension Extension[]? - 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.

substitution MedicationKnowledgeRegulatorySubstitution[]? - Specifies if changes are allowed when dispensing a medication from a regulatory perspective.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

maxDispense MedicationKnowledgeRegulatoryMaxDispense? - The maximum number of units of the medication that can be dispensed in a period.

regulatoryAuthority Reference - The authority that is specifying the regulations.

health.fhir.r4: MedicationKnowledgeRegulatoryMaxDispense

Closed record

FHIR MedicationKnowledgeRegulatoryMaxDispense datatype record.

Fields

extension Extension[]? - 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.

period Duration? - The period that applies to the maximum number of units.

quantity Quantity - The maximum number of units of the medication that can be dispensed.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: MedicationKnowledgeRegulatorySchedule

Closed record

FHIR MedicationKnowledgeRegulatorySchedule datatype record.

Fields

schedule CodeableConcept - Specifies the specific drug schedule.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: MedicationKnowledgeRegulatorySubstitution

Closed record

FHIR MedicationKnowledgeRegulatorySubstitution datatype record.

Fields

extension Extension[]? - 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.

allowed boolean - Specifies if regulation allows for changes in the medication when dispensing.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - Specifies the type of substitution allowed.

health.fhir.r4: MedicationKnowledgeRelatedMedicationKnowledge

Closed record

FHIR MedicationKnowledgeRelatedMedicationKnowledge datatype record.

Fields

reference Reference[] - Associated documentation about the associated medication knowledge.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - The category of the associated medication knowledge reference.

health.fhir.r4: MedicationRequest

FHIR MedicationRequest resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_MEDICATIONREQUEST(default RESOURCE_NAME_MEDICATIONREQUEST) - The type of the resource describes

meta BaseMedicationRequestMeta(default { profile : [PROFILE_BASE_MEDICATIONREQUEST] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

insurance Reference[]? - Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.

note Annotation[]? - Extra information about the prescription that could not be conveyed by the other attributes.

extension Extension[]? - 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.

substitution MedicationRequestSubstitution? - Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.

courseOfTherapyType CodeableConcept? - The description of the overall patte3rn of the administration of the medication to the patient.

priorPrescription Reference? - A link to a resource representing an earlier order related order or prescription.

subject Reference - A link to a resource representing the person or set of individuals to whom the medication will be given.

modifierExtension Extension[]? - 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).

reasonReference Reference[]? - Condition or observation that supports why the medication was ordered.

language code? - The base language in which the resource is written.

instantiatesUri uri[]? - The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationRequest.

medicationReference Reference - Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.

reportedReference Reference? - Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.

statusReason CodeableConcept? - Captures the reason for the current state of the MedicationRequest.

dispenseRequest MedicationRequestDispenseRequest? - Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

reasonCode CodeableConcept[]? - The reason or the indication for ordering or not ordering the medication.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

doNotPerform boolean? - If true indicates that the provider is asking for the medication request not to occur.

basedOn Reference[]? - A plan or request that is fulfilled in whole or in part by this medication request.

requester Reference? - The individual, organization, or device that initiated the request and has responsibility for its activation.

identifier Identifier[]? - Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.

recorder Reference? - The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.

reportedBoolean boolean? - Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.

authoredOn dateTime? - The date (and perhaps time) when the prescription was initially written or authored on.

performer Reference? - The specified desired performer of the medication treatment (e.g. the performer of the medication administration).

detectedIssue Reference[]? - Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.

supportingInformation Reference[]? - Include additional information (for example, patient height and weight) that supports the ordering of the medication.

encounter Reference? - The Encounter during which this [x] was created or to which the creation of this record is tightly associated.

instantiatesCanonical canonical[]? - The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.

medicationCodeableConcept CodeableConcept - Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.

priority MedicationRequestPriority? - Indicates how quickly the Medication Request should be addressed with respect to other requests.

intent MedicationRequestIntent - Whether the request is a proposal, plan, or an original order.

performerType CodeableConcept? - Indicates the type of performer of the administration of the medication.

contained Resource[]? - 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.

dosageInstruction Dosage[]? - Indicates how the medication is to be used by the patient.

eventHistory Reference[]? - Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[]? - Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).

groupIdentifier Identifier? - A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription.

status MedicationRequestStatus - A code specifying the current state of the order. Generally, this will be active or completed state.

never... - Rest field

health.fhir.r4: MedicationRequestDispenseRequest

Closed record

FHIR MedicationRequestDispenseRequest datatype record.

Fields

validityPeriod Period? - This indicates the validity period of a prescription (stale dating the Prescription).

dispenseInterval Duration? - The minimum period of time that must occur between dispenses of the medication.

extension Extension[]? - 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.

performer Reference? - Indicates the intended dispensing Organization specified by the prescriber.

quantity Quantity? - The amount that is to be dispensed for one fill.

numberOfRepeatsAllowed unsignedInt? - An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that the patient can receive the prescribed medication. Usage Notes: This integer does not include the original order dispense. This means that if an order indicates dispense 30 tablets plus '3 repeats', then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets. A prescriber may explicitly say that zero refills are permitted after the initial dispense.

modifierExtension Extension[]? - 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).

initialFill MedicationRequestDispenseRequestInitialFill? - Indicates the quantity or duration for the first dispense of the medication.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

expectedSupplyDuration Duration? - Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last.

health.fhir.r4: MedicationRequestDispenseRequestInitialFill

Closed record

FHIR MedicationRequestDispenseRequestInitialFill datatype record.

Fields

duration Duration? - The length of time that the first dispense is expected to last.

extension Extension[]? - 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.

quantity Quantity? - The amount or quantity to provide as part of the first dispense.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: MedicationRequestSubstitution

Closed record

FHIR MedicationRequestSubstitution datatype record.

Fields

allowedCodeableConcept CodeableConcept - True if the prescriber allows a different drug to be dispensed from what was prescribed.

reason CodeableConcept? - Indicates the reason for the substitution, or why substitution must or must not be performed.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

allowedBoolean boolean - True if the prescriber allows a different drug to be dispensed from what was prescribed.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: MedicationStatement

FHIR MedicationStatement resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_MEDICATIONSTATEMENT(default RESOURCE_NAME_MEDICATIONSTATEMENT) - The type of the resource describes

meta BaseMedicationStatementMeta(default { profile : [PROFILE_BASE_MEDICATIONSTATEMENT] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

dosage Dosage[]? - Indicates how the medication is/was or should be taken by the patient.

note Annotation[]? - Provides extra information about the medication statement that is not conveyed by the other attributes.

partOf Reference[]? - A larger event of which this particular event is a component or step.

extension Extension[]? - 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.

subject Reference - The person, animal or group who is/was taking the medication.

modifierExtension Extension[]? - 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).

reasonReference Reference[]? - Condition or observation that supports why the medication is being/was taken.

language code? - The base language in which the resource is written.

medicationReference Reference - Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.

statusReason CodeableConcept[]? - Captures the reason for the current state of the MedicationStatement.

informationSource Reference? - The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g. Claim or MedicationRequest.

context Reference? - The encounter or episode of care that establishes the context for this MedicationStatement.

derivedFrom Reference[]? - Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

reasonCode CodeableConcept[]? - A reason for why the medication is being/was taken.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

dateAsserted dateTime? - The date when the medication statement was asserted by the information source.

basedOn Reference[]? - A plan, proposal or order that is fulfilled in whole or in part by this event.

identifier Identifier[]? - Identifiers associated with this Medication Statement that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.

effectivePeriod Period? - The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.taken element is No).

medicationCodeableConcept CodeableConcept - Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.

contained Resource[]? - 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.

effectiveDateTime dateTime? - The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.taken element is No).

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept? - Indicates where the medication is expected to be consumed or administered.

status MedicationStatementStatus - A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally, this will be active or completed.

never... - Rest field

health.fhir.r4: MedicinalProduct

FHIR MedicinalProduct resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_MEDICINALPRODUCT(default RESOURCE_NAME_MEDICINALPRODUCT) - The type of the resource describes

meta BaseMedicinalProductMeta(default { profile : [PROFILE_BASE_MEDICINALPRODUCT] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

attachedDocument Reference[]? - Supporting documentation, typically for regulatory submission.

extension Extension[]? - 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.

crossReference Identifier[]? - Reference to another product, e.g. for linking authorised to investigational product.

modifierExtension Extension[]? - 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).

pharmaceuticalProduct Reference[]? - Pharmaceutical aspects of product.

language code? - The base language in which the resource is written.

'type CodeableConcept? - Regulatory type, e.g. Investigational or Authorized.

marketingStatus MarketingStatus[]? - Marketing status of the medicinal product, in contrast to marketing authorizaton.

masterFile Reference[]? - A master file for to the medicinal product (e.g. Pharmacovigilance System Master File).

productClassification CodeableConcept[]? - Allows the product to be classified by various systems.

contact Reference[]? - A product specific contact, person (in a role), or an organization.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

paediatricUseIndicator CodeableConcept? - If authorised for use in children.

identifier Identifier[]? - Business identifier for this product. Could be an MPID.

manufacturingBusinessOperation MedicinalProductManufacturingBusinessOperation[]? - An operation applied to the product, for manufacturing or adminsitrative purpose.

additionalMonitoringIndicator CodeableConcept? - Whether the Medicinal Product is subject to additional monitoring for regulatory reasons.

packagedMedicinalProduct Reference[]? - Package representation for the product.

specialMeasures string[]? - Whether the Medicinal Product is subject to special measures for regulatory reasons.

contained Resource[]? - 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.

legalStatusOfSupply CodeableConcept? - The legal status of supply of the medicinal product as classified by the regulator.

domain Coding? - If this medicine applies to human or veterinary uses.

name MedicinalProductName[] - The product's name, including full name and possibly coded parts.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

specialDesignation MedicinalProductSpecialDesignation[]? - Indicates if the medicinal product has an orphan designation for the treatment of a rare disease.

clinicalTrial Reference[]? - Clinical trials or studies that this product is involved in.

combinedPharmaceuticalDoseForm CodeableConcept? - The dose form for a single part product, or combined form of a multiple part product.

never... - Rest field

health.fhir.r4: MedicinalProductAuthorization

FHIR MedicinalProductAuthorization resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_MEDICINALPRODUCTAUTHORIZATION(default RESOURCE_NAME_MEDICINALPRODUCTAUTHORIZATION) - The type of the resource describes

meta BaseMedicinalProductAuthorizationMeta(default { profile : [PROFILE_BASE_MEDICINALPRODUCTAUTHORIZATION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

statusDate dateTime? - The date at which the given status has become applicable.

country CodeableConcept[]? - The country in which the marketing authorization has been granted.

identifier Identifier[]? - Business identifier for the marketing authorization, as assigned by a regulator.

extension Extension[]? - 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.

dateOfFirstAuthorization dateTime? - The date when the first authorization was granted by a Medicines Regulatory Agency.

subject Reference? - The medicinal product that is being authorized.

internationalBirthDate dateTime? - Date of first marketing authorization for a company's new medicinal product in any country in the World.

jurisdiction CodeableConcept[]? - Jurisdiction within a country.

modifierExtension Extension[]? - 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).

legalBasis CodeableConcept? - The legal framework against which this authorization is granted.

holder Reference? - Marketing Authorization Holder.

language code? - The base language in which the resource is written.

procedure MedicinalProductAuthorizationProcedure? - The regulatory procedure for granting or amending a marketing authorization.

jurisdictionalAuthorization MedicinalProductAuthorizationJurisdictionalAuthorization[]? - Authorization in areas within a country.

validityPeriod Period? - The beginning of the time period in which the marketing authorization is in the specific status shall be specified A complete date consisting of day, month and year shall be specified using the ISO 8601 date format.

contained Resource[]? - 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.

dataExclusivityPeriod Period? - A period of time after authorization before generic product applicatiosn can be submitted.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

regulator Reference? - Medicines Regulatory Agency.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

restoreDate dateTime? - The date when a suspended the marketing or the marketing authorization of the product is anticipated to be restored.

status CodeableConcept? - The status of the marketing authorization.

never... - Rest field

health.fhir.r4: MedicinalProductAuthorizationJurisdictionalAuthorization

Closed record

FHIR MedicinalProductAuthorizationJurisdictionalAuthorization datatype record.

Fields

validityPeriod Period? - The start and expected end date of the authorization.

country CodeableConcept? - Country of authorization.

identifier Identifier[]? - The assigned number for the marketing authorization.

extension Extension[]? - 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.

legalStatusOfSupply CodeableConcept? - The legal status of supply in a jurisdiction or region.

jurisdiction CodeableConcept[]? - Jurisdiction within a country.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: MedicinalProductAuthorizationProcedure

Closed record

FHIR MedicinalProductAuthorizationProcedure datatype record.

Fields

dateDateTime dateTime? - Date of procedure.

identifier Identifier? - Identifier for this procedure.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

datePeriod Period? - Date of procedure.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept - Type of procedure.

health.fhir.r4: MedicinalProductContraindication

FHIR MedicinalProductContraindication resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_MEDICINALPRODUCTCONTRAINDICATION(default RESOURCE_NAME_MEDICINALPRODUCTCONTRAINDICATION) - The type of the resource describes

meta BaseMedicinalProductContraindicationMeta(default { profile : [PROFILE_BASE_MEDICINALPRODUCTCONTRAINDICATION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

extension Extension[]? - 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.

disease CodeableConcept? - The disease, symptom or procedure for the contraindication.

subject Reference[]? - The medication for which this is an indication.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

therapeuticIndication Reference[]? - Information about the use of the medicinal product in relation to other therapies as part of the indication.

population Population[]? - The population group to which this applies.

diseaseStatus CodeableConcept? - The status of the disease or symptom for the contraindication.

contained Resource[]? - 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.

otherTherapy MedicinalProductContraindicationOtherTherapy[]? - Information about the use of the medicinal product in relation to other therapies described as part of the indication.

comorbidity CodeableConcept[]? - A comorbidity (concurrent condition) or coinfection.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

never... - Rest field

health.fhir.r4: MedicinalProductContraindicationOtherTherapy

Closed record

FHIR MedicinalProductContraindicationOtherTherapy datatype record.

Fields

medicationReference Reference - Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication.

extension Extension[]? - 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.

therapyRelationshipType CodeableConcept - The type of relationship between the medicinal product indication or contraindication and another therapy.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

medicationCodeableConcept CodeableConcept - Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication.

health.fhir.r4: MedicinalProductIndication

FHIR MedicinalProductIndication resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_MEDICINALPRODUCTINDICATION(default RESOURCE_NAME_MEDICINALPRODUCTINDICATION) - The type of the resource describes

meta BaseMedicinalProductIndicationMeta(default { profile : [PROFILE_BASE_MEDICINALPRODUCTINDICATION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

extension Extension[]? - 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.

intendedEffect CodeableConcept? - The intended effect, aim or strategy to be achieved by the indication.

subject Reference[]? - The medication for which this is an indication.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

population Population[]? - The population group to which this applies.

diseaseStatus CodeableConcept? - The status of the disease or symptom for which the indication applies.

duration Quantity? - Timing or duration information as part of the indication.

undesirableEffect Reference[]? - Describe the undesirable effects of the medicinal product.

contained Resource[]? - 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.

otherTherapy MedicinalProductIndicationOtherTherapy[]? - Information about the use of the medicinal product in relation to other therapies described as part of the indication.

comorbidity CodeableConcept[]? - Comorbidity (concurrent condition) or co-infection as part of the indication.

diseaseSymptomProcedure CodeableConcept? - The disease, symptom or procedure that is the indication for treatment.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

never... - Rest field

health.fhir.r4: MedicinalProductIndicationOtherTherapy

Closed record

FHIR MedicinalProductIndicationOtherTherapy datatype record.

Fields

medicationReference Reference - Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication.

extension Extension[]? - 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.

therapyRelationshipType CodeableConcept - The type of relationship between the medicinal product indication or contraindication and another therapy.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

medicationCodeableConcept CodeableConcept - Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication.

health.fhir.r4: MedicinalProductIngredient

FHIR MedicinalProductIngredient resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_MEDICINALPRODUCTINGREDIENT(default RESOURCE_NAME_MEDICINALPRODUCTINGREDIENT) - The type of the resource describes

meta BaseMedicinalProductIngredientMeta(default { profile : [PROFILE_BASE_MEDICINALPRODUCTINGREDIENT] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

identifier Identifier? - The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.

extension Extension[]? - 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.

role CodeableConcept - Ingredient role e.g. Active ingredient, excipient.

modifierExtension Extension[]? - 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).

substance MedicinalProductIngredientSubstance? - The ingredient substance.

language code? - The base language in which the resource is written.

allergenicIndicator boolean? - If the ingredient is a known or suspected allergen.

manufacturer Reference[]? - Manufacturer of this Ingredient.

contained Resource[]? - 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.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

specifiedSubstance MedicinalProductIngredientSpecifiedSubstance[]? - A specified substance that comprises this ingredient.

never... - Rest field

health.fhir.r4: MedicinalProductIngredientSpecifiedSubstance

Closed record

FHIR MedicinalProductIngredientSpecifiedSubstance datatype record.

Fields

extension Extension[]? - 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.

code CodeableConcept - The specified substance.

strength MedicinalProductIngredientSpecifiedSubstanceStrength[]? - Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product.

confidentiality CodeableConcept? - Confidentiality level of the specified substance as the ingredient.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

group CodeableConcept - The group of specified substance, e.g. group 1 to 4.

health.fhir.r4: MedicinalProductIngredientSpecifiedSubstanceStrength

Closed record

FHIR MedicinalProductIngredientSpecifiedSubstanceStrength datatype record.

Fields

concentrationLowLimit Ratio? - A lower limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the upper limit.

presentation Ratio - The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item.

country CodeableConcept[]? - The country or countries for which the strength range applies.

extension Extension[]? - 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.

referenceStrength MedicinalProductIngredientSpecifiedSubstanceStrengthReferenceStrength[]? - Strength expressed in terms of a reference substance.

modifierExtension Extension[]? - 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).

concentration Ratio? - The strength per unitary volume (or mass).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

measurementPoint string? - For when strength is measured at a particular point or distance.

presentationLowLimit Ratio? - A lower limit for the quantity of substance in the unit of presentation. For use when there is a range of strengths, this is the lower limit, with the presentation attribute becoming the upper limit.

health.fhir.r4: MedicinalProductIngredientSpecifiedSubstanceStrengthReferenceStrength

Closed record

FHIR MedicinalProductIngredientSpecifiedSubstanceStrengthReferenceStrength datatype record.

Fields

country CodeableConcept[]? - The country or countries for which the strength range applies.

extension Extension[]? - 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.

strength Ratio - Strength expressed in terms of a reference substance.

modifierExtension Extension[]? - 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).

substance CodeableConcept? - Relevant reference substance.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

strengthLowLimit Ratio? - Strength expressed in terms of a reference substance.

measurementPoint string? - For when strength is measured at a particular point or distance.

health.fhir.r4: MedicinalProductIngredientSubstance

Closed record

FHIR MedicinalProductIngredientSubstance datatype record.

Fields

extension Extension[]? - 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.

code CodeableConcept - The ingredient substance.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: MedicinalProductInteraction

FHIR MedicinalProductInteraction resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_MEDICINALPRODUCTINTERACTION(default RESOURCE_NAME_MEDICINALPRODUCTINTERACTION) - The type of the resource describes

meta BaseMedicinalProductInteractionMeta(default { profile : [PROFILE_BASE_MEDICINALPRODUCTINTERACTION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

extension Extension[]? - 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.

subject Reference[]? - The medication for which this is a described interaction.

modifierExtension Extension[]? - 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).

description string? - The interaction described.

language code? - The base language in which the resource is written.

'type CodeableConcept? - The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction.

contained Resource[]? - 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.

management CodeableConcept? - Actions for managing the interaction.

effect CodeableConcept? - The effect of the interaction, for example 'reduced gastric absorption of primary medication'.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

interactant MedicinalProductInteractionInteractant[]? - The specific medication, food or laboratory test that interacts.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

incidence CodeableConcept? - The incidence of the interaction, e.g. theoretical, observed.

never... - Rest field

health.fhir.r4: MedicinalProductInteractionInteractant

Closed record

FHIR MedicinalProductInteractionInteractant datatype record.

Fields

itemReference Reference - The specific medication, food or laboratory test that interacts.

extension Extension[]? - 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.

itemCodeableConcept CodeableConcept - The specific medication, food or laboratory test that interacts.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: MedicinalProductManufactured

FHIR MedicinalProductManufactured resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_MEDICINALPRODUCTMANUFACTURED(default RESOURCE_NAME_MEDICINALPRODUCTMANUFACTURED) - The type of the resource describes

meta BaseMedicinalProductManufacturedMeta(default { profile : [PROFILE_BASE_MEDICINALPRODUCTMANUFACTURED] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

extension Extension[]? - 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.

otherCharacteristics CodeableConcept[]? - Other codeable characteristics.

ingredient Reference[]? - Ingredient.

quantity Quantity - The quantity or 'count number' of the manufactured item.

modifierExtension Extension[]? - 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).

physicalCharacteristics ProdCharacteristic? - Dimensions, color etc.

language code? - The base language in which the resource is written.

manufacturer Reference[]? - Manufacturer of the item (Note that this should be named 'manufacturer' but it currently causes technical issues).

contained Resource[]? - 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.

unitOfPresentation CodeableConcept? - The “real world” units in which the quantity of the manufactured item is described.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

manufacturedDoseForm CodeableConcept - Dose form as manufactured and before any transformation into the pharmaceutical product.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

never... - Rest field

health.fhir.r4: MedicinalProductManufacturingBusinessOperation

Closed record

FHIR MedicinalProductManufacturingBusinessOperation datatype record.

Fields

confidentialityIndicator CodeableConcept? - To indicate if this proces is commercially confidential.

extension Extension[]? - 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.

authorisationReferenceNumber Identifier? - Regulatory authorization reference number.

modifierExtension Extension[]? - 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).

regulator Reference? - A regulator which oversees the operation.

operationType CodeableConcept? - The type of manufacturing operation.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

effectiveDate dateTime? - Regulatory authorization date.

manufacturer Reference[]? - The manufacturer or establishment associated with the process.

health.fhir.r4: MedicinalProductName

Closed record

FHIR MedicinalProductName datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

countryLanguage MedicinalProductNameCountryLanguage[]? - Country where the name applies.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

namePart MedicinalProductNameNamePart[]? - Coding words or phrases of the name.

productName string - The full product name.

health.fhir.r4: MedicinalProductNameCountryLanguage

Closed record

FHIR MedicinalProductNameCountryLanguage datatype record.

Fields

country CodeableConcept - Country code for where this name applies.

extension Extension[]? - 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.

jurisdiction CodeableConcept? - Jurisdiction code for where this name applies.

modifierExtension Extension[]? - 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).

language CodeableConcept - Language code for this name.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: MedicinalProductNameNamePart

Closed record

FHIR MedicinalProductNameNamePart datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

part string - A fragment of a product name.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type Coding - Idenifying type for this part of the name (e.g. strength part).

health.fhir.r4: MedicinalProductPackaged

FHIR MedicinalProductPackaged resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_MEDICINALPRODUCTPACKAGED(default RESOURCE_NAME_MEDICINALPRODUCTPACKAGED) - The type of the resource describes

meta BaseMedicinalProductPackagedMeta(default { profile : [PROFILE_BASE_MEDICINALPRODUCTPACKAGED] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

identifier Identifier[]? - Unique identifier.

extension Extension[]? - 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.

marketingAuthorization Reference? - Manufacturer of this Package Item.

subject Reference[]? - The product with this is a pack for.

modifierExtension Extension[]? - 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).

description string? - Textual description.

language code? - The base language in which the resource is written.

manufacturer Reference[]? - Manufacturer of this Package Item.

marketingStatus MarketingStatus[]? - Marketing information.

packageItem MedicinalProductPackagedPackageItem[] - A packaging item, as a contained for medicine, possibly with other packaging items within.

contained Resource[]? - 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.

legalStatusOfSupply CodeableConcept? - The legal status of supply of the medicinal product as classified by the regulator.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

batchIdentifier MedicinalProductPackagedBatchIdentifier[]? - Batch numbering.

never... - Rest field

health.fhir.r4: MedicinalProductPackagedBatchIdentifier

Closed record

FHIR MedicinalProductPackagedBatchIdentifier datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

immediatePackaging Identifier? - A number appearing on the immediate packaging (and not the outer packaging).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

outerPackaging Identifier - A number appearing on the outer packaging of a specific batch.

health.fhir.r4: MedicinalProductPackagedPackageItem

Closed record

FHIR MedicinalProductPackagedPackageItem datatype record.

Fields

identifier Identifier[]? - Including possibly Data Carrier Identifier.

extension Extension[]? - 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.

otherCharacteristics CodeableConcept[]? - Other codeable characteristics.

quantity Quantity - The quantity of this package in the medicinal product, at the current level of packaging. The outermost is always 1.

manufacturedItem Reference[]? - The manufactured item as contained in the packaged medicinal product.

modifierExtension Extension[]? - 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).

physicalCharacteristics ProdCharacteristic? - Dimensions, color etc.

'type CodeableConcept - The physical type of the container of the medicine.

manufacturer Reference[]? - Manufacturer of this Package Item.

material CodeableConcept[]? - Material type of the package item.

shelfLifeStorage ProductShelfLife[]? - Shelf Life and storage information.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

alternateMaterial CodeableConcept[]? - A possible alternate material for the packaging.

device Reference[]? - A device accompanying a medicinal product.

health.fhir.r4: MedicinalProductPharmaceutical

FHIR MedicinalProductPharmaceutical resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_MEDICINALPRODUCTPHARMACEUTICAL(default RESOURCE_NAME_MEDICINALPRODUCTPHARMACEUTICAL) - The type of the resource describes

meta BaseMedicinalProductPharmaceuticalMeta(default { profile : [PROFILE_BASE_MEDICINALPRODUCTPHARMACEUTICAL] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

identifier Identifier[]? - An identifier for the pharmaceutical medicinal product.

characteristics MedicinalProductPharmaceuticalCharacteristics[]? - Characteristics e.g. a products onset of action.

extension Extension[]? - 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.

administrableDoseForm CodeableConcept - The administrable dose form, after necessary reconstitution.

ingredient Reference[]? - Ingredient.

modifierExtension Extension[]? - 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).

routeOfAdministration MedicinalProductPharmaceuticalRouteOfAdministration[] - The path by which the pharmaceutical product is taken into or makes contact with the body.

language code? - The base language in which the resource is written.

contained Resource[]? - 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.

unitOfPresentation CodeableConcept? - Todo.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

device Reference[]? - Accompanying device.

never... - Rest field

health.fhir.r4: MedicinalProductPharmaceuticalCharacteristics

Closed record

FHIR MedicinalProductPharmaceuticalCharacteristics datatype record.

Fields

extension Extension[]? - 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.

code CodeableConcept - A coded characteristic.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

status CodeableConcept? - The status of characteristic e.g. assigned or pending.

health.fhir.r4: MedicinalProductPharmaceuticalRouteOfAdministration

Closed record

FHIR MedicinalProductPharmaceuticalRouteOfAdministration datatype record.

Fields

extension Extension[]? - 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.

code CodeableConcept - Coded expression for the route.

maxSingleDose Quantity? - The maximum single dose that can be administered as per the protocol of a clinical trial can be specified using a numerical value and its unit of measurement.

maxTreatmentPeriod Duration? - The maximum treatment period during which an Investigational Medicinal Product can be administered as per the protocol referenced in the clinical trial authorisation.

modifierExtension Extension[]? - 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).

targetSpecies MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpecies[]? - A species for which this route applies.

firstDose Quantity? - The first dose (dose quantity) administered in humans can be specified, for a product under investigation, using a numerical value and its unit of measurement.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

maxDosePerDay Quantity? - The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered as per the protocol referenced in the clinical trial authorisation.

maxDosePerTreatmentPeriod Ratio? - The maximum dose per treatment period that can be administered as per the protocol referenced in the clinical trial authorisation.

health.fhir.r4: MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpecies

Closed record

FHIR MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpecies datatype record.

Fields

extension Extension[]? - 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.

code CodeableConcept - Coded expression for the species.

modifierExtension Extension[]? - 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).

withdrawalPeriod MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesWithdrawalPeriod[]? - A species specific time during which consumption of animal product is not appropriate.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesWithdrawalPeriod

Closed record

FHIR MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesWithdrawalPeriod datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

supportingInformation string? - Extra information about the withdrawal period.

tissue CodeableConcept - Coded expression for the type of tissue for which the withdrawal period applues, e.g. meat, milk.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

value Quantity - A value for the time.

health.fhir.r4: MedicinalProductSpecialDesignation

Closed record

FHIR MedicinalProductSpecialDesignation datatype record.

Fields

date dateTime? - Date when the designation was granted.

identifier Identifier[]? - Identifier for the designation, or procedure number.

extension Extension[]? - 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.

species CodeableConcept? - Animal species for which this applies.

modifierExtension Extension[]? - 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).

intendedUse CodeableConcept? - The intended use of the product, e.g. prevention, treatment.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

indicationReference Reference? - Condition for which the medicinal use applies.

'type CodeableConcept? - The type of special designation, e.g. orphan drug, minor use.

indicationCodeableConcept CodeableConcept? - Condition for which the medicinal use applies.

status CodeableConcept? - For example granted, pending, expired or withdrawn.

health.fhir.r4: MedicinalProductUndesirableEffect

FHIR MedicinalProductUndesirableEffect resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_MEDICINALPRODUCTUNDESIRABLEEFFECT(default RESOURCE_NAME_MEDICINALPRODUCTUNDESIRABLEEFFECT) - The type of the resource describes

meta BaseMedicinalProductUndesirableEffectMeta(default { profile : [PROFILE_BASE_MEDICINALPRODUCTUNDESIRABLEEFFECT] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

extension Extension[]? - 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.

subject Reference[]? - The medication for which this is an indication.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

classification CodeableConcept? - Classification of the effect.

frequencyOfOccurrence CodeableConcept? - The frequency of occurrence of the effect.

population Population[]? - The population group to which this applies.

contained Resource[]? - 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.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

symptomConditionEffect CodeableConcept? - The symptom, condition or undesirable effect.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

never... - Rest field

health.fhir.r4: MessageDefinition

FHIR MessageDefinition resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_MESSAGEDEFINITION(default RESOURCE_NAME_MESSAGEDEFINITION) - The type of the resource describes

meta BaseMessageDefinitionMeta(default { profile : [PROFILE_BASE_MESSAGEDEFINITION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime - The date (and optionally time) when the message definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the message definition changes.

parent canonical[]? - Identifies a protocol or workflow that this MessageDefinition represents a step in.

copyright markdown? - A copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition.

extension Extension[]? - 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.

purpose markdown? - Explanation of why this message definition is needed and why it has been designed as it has.

jurisdiction CodeableConcept[]? - A legal or geographic region in which the message definition is intended to be used.

modifierExtension Extension[]? - 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).

description markdown? - A free text natural language description of the message definition from a consumer's perspective.

focus MessageDefinitionFocus[]? - Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.

experimental boolean? - A Boolean value to indicate that this message definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language code? - The base language in which the resource is written.

title string? - A short, descriptive, user-friendly title for the message definition.

contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

allowedResponse MessageDefinitionAllowedResponse[]? - Indicates what types of messages may be sent as an application-level response to this message.

eventUri uri - Event code or link to the EventDefinition.

identifier Identifier[]? - A formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

replaces canonical[]? - A MessageDefinition that is superseded by this definition.

eventCoding Coding - Event code or link to the EventDefinition.

'version string? - The identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

graph canonical[]? - Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a GraphDefinition that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources.

responseRequired MessageDefinitionResponseRequired? - Declare at a message definition level whether a response is required or only upon error or success, or never.

url uri? - The business identifier that is used to reference the MessageDefinition and is expected to be consistent from server to server.

contained Resource[]? - 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.

name string? - A natural language name identifying the message definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher string? - The name of the organization or individual that published the message definition.

category MessageDefinitionCategory? - The impact of the content of the message.

useContext UsageContext[]? - 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 message definition instances.

base canonical? - The MessageDefinition that is the basis for the contents of this resource.

status MessageDefinitionStatus - The status of this message definition. Enables tracking the life-cycle of the content.

never... - Rest field

health.fhir.r4: MessageDefinitionAllowedResponse

Closed record

FHIR MessageDefinitionAllowedResponse datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

message canonical - A reference to the message definition that must be adhered to by this supported response.

situation markdown? - Provides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses).

health.fhir.r4: MessageDefinitionFocus

Closed record

FHIR MessageDefinitionFocus datatype record.

Fields

extension Extension[]? - 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.

code code - The kind of resource that must be the focus for this message.

min unsignedInt - Identifies the minimum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.

max string? - Identifies the maximum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.

modifierExtension Extension[]? - 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).

profile canonical? - A profile that reflects constraints for the focal resource (and potentially for related resources).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: MessageHeader

FHIR MessageHeader resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_MESSAGEHEADER(default RESOURCE_NAME_MESSAGEHEADER) - The type of the resource describes

meta BaseMessageHeaderMeta(default { profile : [PROFILE_BASE_MESSAGEHEADER] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

eventUri uri - Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value 'http://terminology.hl7.org/CodeSystem/message-events'. Alternatively uri to the EventDefinition.

reason CodeableConcept? - Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.

extension Extension[]? - 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.

author Reference? - The logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.

modifierExtension Extension[]? - 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).

destination MessageHeaderDestination[]? - The destination application which the message is intended for.

focus Reference[]? - The actual data of the message - a reference to the root/focus class of the event.

language code? - The base language in which the resource is written.

'source MessageHeaderSource - The source application from which this message originated.

eventCoding Coding - Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value 'http://terminology.hl7.org/CodeSystem/message-events'. Alternatively uri to the EventDefinition.

contained Resource[]? - 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.

sender Reference? - Identifies the sending system to allow the use of a trust relationship.

response MessageHeaderResponse? - Information about the message that this message is a response to. Only present if this message is a response.

responsible Reference? - The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.

enterer Reference? - The person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

definition canonical? - Permanent link to the MessageDefinition for this message.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

never... - Rest field

health.fhir.r4: MessageHeaderDestination

Closed record

FHIR MessageHeaderDestination datatype record.

Fields

endpoint urlType - Indicates where the message should be routed to.

extension Extension[]? - 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.

receiver Reference? - Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.

modifierExtension Extension[]? - 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).

name string? - Human-readable name for the target system.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

target Reference? - Identifies the target end system in situations where the initial message transmission is to an intermediary system.

health.fhir.r4: MessageHeaderResponse

Closed record

FHIR MessageHeaderResponse datatype record.

Fields

identifier id - The MessageHeader.id of the message to which this message is a response.

extension Extension[]? - 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.

code MessageHeaderResponseCode - Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.

modifierExtension Extension[]? - 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).

details Reference? - Full details of any issues found in the message.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: MessageHeaderSource

Closed record

FHIR MessageHeaderSource datatype record.

Fields

endpoint urlType - Identifies the routing target to send acknowledgements to.

extension Extension[]? - 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.

software string? - May include configuration or other information useful in debugging.

contact ContactPoint? - An e-mail, phone, website or other contact point to use to resolve issues with message communications.

modifierExtension Extension[]? - 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).

name string? - Human-readable name for the source system.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'version string? - Can convey versions of multiple systems in situations where a message passes through multiple hands.

health.fhir.r4: Meta

Closed record

Each resource contains an element "meta", of type "Meta", which is a set of metadata that provides technical and workflow context to the resource.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

versionId id? - Version specific identifier

lastUpdated instant? - When the resource version last changed

'source uri? - Identifies where the resource comes from

profile canonical[]? - Profiles this resource claims to conform to

security Coding[]? - Security Labels applied to this resource SecurityLabels(http://hl7.org/fhir/valueset-security-labels.html) (Extensible)

tag Coding[]? - Tags applied to this resource Common Tags(http://hl7.org/fhir/valueset-common-tags.html) (Example)

health.fhir.r4: MetaExtension

Closed record

Fields

url uri -

valueMeta Meta -

health.fhir.r4: MolecularSequence

FHIR MolecularSequence resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_MOLECULARSEQUENCE(default RESOURCE_NAME_MOLECULARSEQUENCE) - The type of the resource describes

meta BaseMolecularSequenceMeta(default { profile : [PROFILE_BASE_MOLECULARSEQUENCE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

identifier Identifier[]? - A unique identifier for this particular sequence instance. This is a FHIR-defined id.

extension Extension[]? - 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.

pointer Reference[]? - Pointer to next atomic sequence which at most contains one variant.

performer Reference? - The organization or lab that should be responsible for this result.

quantity Quantity? - The number of copies of the sequence of interest. (RNASeq).

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

observedSeq string? - Sequence that was observed. It is the result marked by referenceSeq along with variant records on referenceSeq. This shall start from referenceSeq.windowStart and end by referenceSeq.windowEnd.

repository MolecularSequenceRepository[]? - Configurations of the external repository. The repository shall store target's observedSeq or records related with target's observedSeq.

'type MolecularSequenceType? - Amino Acid Sequence/ DNA Sequence / RNA Sequence.

quality MolecularSequenceQuality[]? - An experimental feature attribute that defines the quality of the feature in a quantitative way, such as a phred quality score (SO:0001686).

structureVariant MolecularSequenceStructureVariant[]? - Information about chromosome structure variation.

contained Resource[]? - 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.

patient Reference? - The patient whose sequencing results are described by this resource.

readCoverage integer? - Coverage (read depth or depth) is the average number of reads representing a given nucleotide in the reconstructed sequence.

specimen Reference? - Specimen used for sequencing.

variant MolecularSequenceVariant[]? - The definition of variant here originates from Sequence ontology (variant_of). This element can represent amino acid or nucleic sequence change(including insertion,deletion,SNP,etc.) It can represent some complex mutation or segment variation with the assist of CIGAR string.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

coordinateSystem integer - Whether the sequence is numbered starting at 0 (0-based numbering or coordinates, inclusive start, exclusive end) or starting at 1 (1-based numbering, inclusive start and inclusive end).

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

device Reference? - The method for sequencing, for example, chip information.

referenceSeq MolecularSequenceReferenceSeq? - A sequence that is used as a reference to describe variants that are present in a sequence analyzed.

never... - Rest field

health.fhir.r4: MolecularSequenceQuality

Closed record

FHIR MolecularSequenceQuality datatype record.

Fields

extension Extension[]? - 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.

fScore decimal? - Harmonic mean of Recall and Precision, computed as: 2 * precision * recall / (precision + recall).

method CodeableConcept? - Which method is used to get sequence quality.

truthTP decimal? - True positives, from the perspective of the truth data, i.e. the number of sites in the Truth Call Set for which there are paths through the Query Call Set that are consistent with all of the alleles at this site, and for which there is an accurate genotype call for the event.

gtFP decimal? - The number of false positives where the non-REF alleles in the Truth and Query Call Sets match (i.e. cases where the truth is 1/1 and the query is 0/1 or similar).

modifierExtension Extension[]? - 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).

precision decimal? - QUERY.TP / (QUERY.TP + QUERY.FP).

roc MolecularSequenceQualityRoc? - Receiver Operator Characteristic (ROC) Curve to give sensitivity/specificity tradeoff.

queryTP decimal? - True positives, from the perspective of the query data, i.e. the number of sites in the Query Call Set for which there are paths through the Truth Call Set that are consistent with all of the alleles at this site, and for which there is an accurate genotype call for the event.

'start integer? - Start position of the sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.

'type MolecularSequenceQualityType - INDEL / SNP / Undefined variant.

score Quantity? - The score of an experimentally derived feature such as a p-value (SO:0001685).

standardSequence CodeableConcept? - Gold standard sequence used for comparing against.

truthFN decimal? - False negatives, i.e. the number of sites in the Truth Call Set for which there is no path through the Query Call Set that is consistent with all of the alleles at this site, or sites for which there is an inaccurate genotype call for the event. Sites with correct variant but incorrect genotype are counted here.

recall decimal? - TRUTH.TP / (TRUTH.TP + TRUTH.FN).

end integer? - End position of the sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

queryFP decimal? - False positives, i.e. the number of sites in the Query Call Set for which there is no path through the Truth Call Set that is consistent with this site. Sites with correct variant but incorrect genotype are counted here.

health.fhir.r4: MolecularSequenceQualityRoc

Closed record

FHIR MolecularSequenceQualityRoc datatype record.

Fields

score integer[]? - Invidual data point representing the GQ (genotype quality) score threshold.

extension Extension[]? - 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.

numFP integer[]? - The number of false positives if the GQ score threshold was set to 'score' field value.

fMeasure decimal[]? - Calculated fScore if the GQ score threshold was set to 'score' field value.

numTP integer[]? - The number of true positives if the GQ score threshold was set to 'score' field value.

modifierExtension Extension[]? - 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).

precision decimal[]? - Calculated precision if the GQ score threshold was set to 'score' field value.

numFN integer[]? - The number of false negatives if the GQ score threshold was set to 'score' field value.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

sensitivity decimal[]? - Calculated sensitivity if the GQ score threshold was set to 'score' field value.

health.fhir.r4: MolecularSequenceReferenceSeq

Closed record

FHIR MolecularSequenceReferenceSeq datatype record.

Fields

extension Extension[]? - 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.

orientation MolecularSequenceReferenceSeqOrientation? - A relative reference to a DNA strand based on gene orientation. The strand that contains the open reading frame of the gene is the 'sense' strand, and the opposite complementary strand is the 'antisense' strand.

strand MolecularSequenceReferenceSeqStrand? - An absolute reference to a strand. The Watson strand is the strand whose 5'-end is on the short arm of the chromosome, and the Crick strand as the one whose 5'-end is on the long arm.

referenceSeqString string? - A string like 'ACGT'.

windowStart integer? - Start position of the window on the reference sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.

genomeBuild string? - The Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37'. Version number must be included if a versioned release of a primary build was used.

chromosome CodeableConcept? - Structural unit composed of a nucleic acid molecule which controls its own replication through the interaction of specific proteins at one or more origins of replication (SO:0000340).

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

windowEnd integer? - End position of the window on the reference sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.

referenceSeqPointer Reference? - A pointer to another MolecularSequence entity as reference sequence.

referenceSeqId CodeableConcept? - Reference identifier of reference sequence submitted to NCBI. It must match the type in the MolecularSequence.type field. For example, the prefix, “NG_” identifies reference sequence for genes, “NM_” for messenger RNA transcripts, and “NP_” for amino acid sequences.

health.fhir.r4: MolecularSequenceRepository

Closed record

FHIR MolecularSequenceRepository datatype record.

Fields

extension Extension[]? - 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.

readsetId string? - Id of the read in this external repository.

modifierExtension Extension[]? - 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).

name string? - URI of an external repository which contains further details about the genetics data.

datasetId string? - Id of the variant in this external repository. The server will understand how to use this id to call for more info about datasets in external repository.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type MolecularSequenceRepositoryType - Click and see / RESTful API / Need login to see / RESTful API with authentication / Other ways to see resource.

variantsetId string? - Id of the variantset in this external repository. The server will understand how to use this id to call for more info about variantsets in external repository.

url uri? - URI of an external repository which contains further details about the genetics data.

health.fhir.r4: MolecularSequenceStructureVariant

Closed record

FHIR MolecularSequenceStructureVariant datatype record.

Fields

variantType CodeableConcept? - Information about chromosome structure variation DNA change type.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

exact boolean? - Used to indicate if the outer and inner start-end values have the same meaning.

length integer? - Length of the variant chromosome.

'outer MolecularSequenceStructureVariantOuter? - Structural variant outer.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

inner MolecularSequenceStructureVariantInner? - Structural variant inner.

health.fhir.r4: MolecularSequenceStructureVariantInner

Closed record

FHIR MolecularSequenceStructureVariantInner datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

'start integer? - Structural variant inner start. If the coordinate system is either 0-based or 1-based, then start position is inclusive.

end integer? - Structural variant inner end. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: MolecularSequenceStructureVariantOuter

Closed record

FHIR MolecularSequenceStructureVariantOuter datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

'start integer? - Structural variant outer start. If the coordinate system is either 0-based or 1-based, then start position is inclusive.

end integer? - Structural variant outer end. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: MolecularSequenceVariant

Closed record

FHIR MolecularSequenceVariant datatype record.

Fields

extension Extension[]? - 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.

cigar string? - Extended CIGAR string for aligning the sequence with reference bases. See detailed documentation here.

modifierExtension Extension[]? - 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).

'start integer? - Start position of the variant on the reference sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.

end integer? - End position of the variant on the reference sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.

observedAllele string? - An allele is one of a set of coexisting sequence variants of a gene (SO:0001023). Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the observed sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end.

referenceAllele string? - An allele is one of a set of coexisting sequence variants of a gene (SO:0001023). Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the reference sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

variantPointer Reference? - A pointer to an Observation containing variant information.

health.fhir.r4: Money

Closed record

An amount of economic utility in some recognized currency.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

value decimal? - Numerical value (with implicit precision)

currency code? - ISO 4217 Currency Code (Required) (https://hl7.org/fhir/valueset-currencies.html)

health.fhir.r4: MoneyExtension

Closed record

Fields

url uri -

valueMoney Money -

health.fhir.r4: MoneyQuantity

Closed record

Fields

Fields Included from *Quantity

id string
extension Extension[]
value decimal
comparator QuantityComparatorCode
unit string
system uri
code code
Element...

id string? -

extension Extension[]? -

moneyValue decimal? -

unit string? -

system uri? -

code code? -

health.fhir.r4: NamingSystem

FHIR NamingSystem resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_NAMINGSYSTEM(default RESOURCE_NAME_NAMINGSYSTEM) - The type of the resource describes

meta BaseNamingSystemMeta(default { profile : [PROFILE_BASE_NAMINGSYSTEM] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime - The date (and optionally time) when the naming system was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changes.

extension Extension[]? - 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.

kind NamingSystemKind - Indicates the purpose for the naming system - what kinds of things does it make unique?

jurisdiction CodeableConcept[]? - A legal or geographic region in which the naming system is intended to be used.

modifierExtension Extension[]? - 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).

usage string? - Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.

description markdown? - A free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc.

language code? - The base language in which the resource is written.

'type CodeableConcept? - Categorizes a naming system for easier search by grouping related naming systems.

contained Resource[]? - 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.

contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.

responsible string? - The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.

name string - A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher string? - The name of the organization or individual that published the naming system.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

useContext UsageContext[]? - 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 naming system instances.

uniqueId NamingSystemUniqueId[] - Indicates how the system may be identified when referenced in electronic exchange.

status NamingSystemStatus - The status of this naming system. Enables tracking the life-cycle of the content.

never... - Rest field

health.fhir.r4: NamingSystemUniqueId

Closed record

FHIR NamingSystemUniqueId datatype record.

Fields

extension Extension[]? - 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.

period Period? - Identifies the period of time over which this identifier is considered appropriate to refer to the naming system. Outside of this window, the identifier might be non-deterministic.

modifierExtension Extension[]? - 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).

comment string? - Notes about the past or intended usage of this identifier.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type NamingSystemUniqueIdType - Identifies the unique identifier scheme used for this particular identifier.

value string - The string that should be sent over the wire to identify the code system or identifier system.

preferred boolean? - Indicates whether this identifier is the 'preferred' identifier of this type.

health.fhir.r4: Narrative

Closed record

Human-readable summary of the resource (essential clinical and business information).

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

status StatusCode - [generated | extensions | additional | empty] NarrativeStatus(http://hl7.org/fhir/valueset-narrative-status.html) (Required)

div xhtml - Limited xhtml content
- Rule: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
- Rule: The narrative SHALL have some non-whitespace content

health.fhir.r4: NotAvailableTime

Closed record

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? -

extension Extension[]? -

description string? -

during Period? -

health.fhir.r4: NumberSearchParameter

Number type search parameter information.

Fields

Fields Included from *FHIRTypedSearchParameter

modifier "text-advanced"|"text"|"of-type"|"not-in"|"not"|"missing"|"iterate"|"in"|"identifier"|"exact"|"contains"|"code-text"|"below"|"above"|string|()
anydata...

prefixreadonly Prefix(default eq) - prefix is used to control the nature of the matching

valuereadonly int|float - Value of the received search parameter

health.fhir.r4: NutritionOrder

FHIR NutritionOrder resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_NUTRITIONORDER(default RESOURCE_NAME_NUTRITIONORDER) - The type of the resource describes

meta BaseNutritionOrderMeta(default { profile : [PROFILE_BASE_NUTRITIONORDER] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

dateTime dateTime - The date and time that this nutrition order was requested.

instantiates uri[]? - The URL pointing to a protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.

note Annotation[]? - Comments made about the {{title}} by the requester, performer, subject or other participants.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

instantiatesUri uri[]? - The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.

patient Reference - The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

foodPreferenceModifier CodeableConcept[]? - This modifier is used to convey order-specific modifiers about the type of food that should be given. These can be derived from patient allergies, intolerances, or preferences such as Halal, Vegan or Kosher. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.

identifier Identifier[]? - Identifiers assigned to this order by the order sender or by the order receiver.

enteralFormula NutritionOrderEnteralFormula? - Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.

oralDiet NutritionOrderOralDiet? - Diet given orally in contrast to enteral (tube) feeding.

excludeFoodModifier CodeableConcept[]? - This modifier is used to convey Order-specific modifier about the type of oral food or oral fluids that should not be given. These can be derived from patient allergies, intolerances, or preferences such as No Red Meat, No Soy or No Wheat or Gluten-Free. While it should not be necessary to repeat allergy or intolerance information captured in the referenced AllergyIntolerance resource in the excludeFoodModifier, this element may be used to convey additional specificity related to foods that should be eliminated from the patient’s diet for any reason. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.

encounter Reference? - An encounter that provides additional information about the healthcare context in which this request is made.

instantiatesCanonical canonical[]? - The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.

intent NutritionOrderIntent - Indicates the level of authority/intentionality associated with the NutrionOrder and where the request fits into the workflow chain.

contained Resource[]? - 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.

supplement NutritionOrderSupplement[]? - Oral nutritional products given in order to add further nutritional value to the patient's diet.

orderer Reference? - The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

allergyIntolerance Reference[]? - A link to a record of allergies or intolerances which should be included in the nutrition order.

status NutritionOrderStatus - The workflow status of the nutrition order/request.

never... - Rest field

health.fhir.r4: NutritionOrderEnteralFormula

Closed record

FHIR NutritionOrderEnteralFormula datatype record.

Fields

extension Extension[]? - 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.

administrationInstruction string? - Free text formula administration, feeding instructions or additional instructions or information.

baseFormulaProductName string? - The product or brand name of the enteral or infant formula product such as 'ACME Adult Standard Formula'.

additiveType CodeableConcept? - Indicates the type of modular component such as protein, carbohydrate, fat or fiber to be provided in addition to or mixed with the base formula.

administration NutritionOrderEnteralFormulaAdministration[]? - Formula administration instructions as structured data. This repeating structure allows for changing the administration rate or volume over time for both bolus and continuous feeding. An example of this would be an instruction to increase the rate of continuous feeding every 2 hours.

baseFormulaType CodeableConcept? - The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.

modifierExtension Extension[]? - 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).

caloricDensity Quantity? - The amount of energy (calories) that the formula should provide per specified volume, typically per mL or fluid oz. For example, an infant may require a formula that provides 24 calories per fluid ounce or an adult may require an enteral formula that provides 1.5 calorie/mL.

additiveProductName string? - The product or brand name of the type of modular component to be added to the formula.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

maxVolumeToDeliver Quantity? - The maximum total quantity of formula that may be administered to a subject over the period of time, e.g. 1440 mL over 24 hours.

routeofAdministration CodeableConcept? - The route or physiological path of administration into the patient's gastrointestinal tract for purposes of providing the formula feeding, e.g. nasogastric tube.

health.fhir.r4: NutritionOrderEnteralFormulaAdministration

Closed record

FHIR NutritionOrderEnteralFormulaAdministration datatype record.

Fields

schedule Timing? - The time period and frequency at which the enteral formula should be delivered to the patient.

extension Extension[]? - 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.

rateRatio Ratio? - The rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule.

quantity Quantity? - The volume of formula to provide to the patient per the specified administration schedule.

rateQuantity Quantity? - The rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: NutritionOrderOralDiet

Closed record

FHIR NutritionOrderOralDiet datatype record.

Fields

schedule Timing[]? - The time period and frequency at which the diet should be given. The diet should be given for the combination of all schedules if more than one schedule is present.

extension Extension[]? - 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.

nutrient NutritionOrderOralDietNutrient[]? - Class that defines the quantity and type of nutrient modifications (for example carbohydrate, fiber or sodium) required for the oral diet.

instruction string? - Free text or additional instructions or information pertaining to the oral diet.

texture NutritionOrderOralDietTexture[]? - Class that describes any texture modifications required for the patient to safely consume various types of solid foods.

modifierExtension Extension[]? - 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).

fluidConsistencyType CodeableConcept[]? - The required consistency (e.g. honey-thick, nectar-thick, thin, thickened.) of liquids or fluids served to the patient.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept[]? - The kind of diet or dietary restriction such as fiber restricted diet or diabetic diet.

health.fhir.r4: NutritionOrderOralDietNutrient

Closed record

FHIR NutritionOrderOralDietNutrient datatype record.

Fields

amount Quantity? - The quantity of the specified nutrient to include in diet.

extension Extension[]? - 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.

modifier CodeableConcept? - The nutrient that is being modified such as carbohydrate or sodium.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: NutritionOrderOralDietTexture

Closed record

FHIR NutritionOrderOralDietTexture datatype record.

Fields

extension Extension[]? - 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.

foodType CodeableConcept? - The food type(s) (e.g. meats, all foods) that the texture modification applies to. This could be all foods types.

modifier CodeableConcept? - Any texture modifications (for solid foods) that should be made, e.g. easy to chew, chopped, ground, and pureed.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: NutritionOrderSupplement

Closed record

FHIR NutritionOrderSupplement datatype record.

Fields

schedule Timing[]? - The time period and frequency at which the supplement(s) should be given. The supplement should be given for the combination of all schedules if more than one schedule is present.

extension Extension[]? - 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.

quantity Quantity? - The amount of the nutritional supplement to be given.

instruction string? - Free text or additional instructions or information pertaining to the oral supplement.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept? - The kind of nutritional supplement product required such as a high protein or pediatric clear liquid supplement.

productName string? - The product or brand name of the nutritional supplement such as 'Acme Protein Shake'.

health.fhir.r4: Observation

FHIR Observation resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_OBSERVATION(default RESOURCE_NAME_OBSERVATION) - The type of the resource describes

meta BaseObservationMeta(default { profile : [PROFILE_BASE_OBSERVATION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

valueBoolean boolean? - The information determined as a result of making the observation, if the information has a simple value.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.

note Annotation[]? - Comments about the observation or the results.

partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

extension Extension[]? - 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.

valueTime time? - The information determined as a result of making the observation, if the information has a simple value.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'name'.

subject Reference? - The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus element or the code itself specifies the actual focus of the observation.

valueRange Range? - The information determined as a result of making the observation, if the information has a simple value.

modifierExtension Extension[]? - 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).

focus Reference[]? - The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.

language code? - The base language in which the resource is written.

valueCodeableConcept CodeableConcept? - The information determined as a result of making the observation, if the information has a simple value.

valueRatio Ratio? - The information determined as a result of making the observation, if the information has a simple value.

specimen Reference? - The specimen that was used when this observation was made.

derivedFrom Reference[]? - The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.

valueDateTime dateTime? - The information determined as a result of making the observation, if the information has a simple value.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

valueInteger integer? - The information determined as a result of making the observation, if the information has a simple value.

basedOn Reference[]? - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.

valueQuantity Quantity? - The information determined as a result of making the observation, if the information has a simple value.

identifier Identifier[]? - A unique identifier assigned to this observation.

performer Reference[]? - Who was responsible for asserting the observed value as 'true'.

effectivePeriod Period? - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.

effectiveTiming Timing? - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.

method CodeableConcept? - Indicates the mechanism used to perform the observation.

hasMember Reference[]? - This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component ObservationComponentOne[]? - Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.

contained Resource[]? - 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.

referenceRange ObservationReferenceRangeOne[]? - Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an 'OR'. In other words, to represent two distinct target populations, two referenceRange elements would be used.

valueString string? - The information determined as a result of making the observation, if the information has a simple value.

effectiveDateTime dateTime? - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData SampledData? - The information determined as a result of making the observation, if the information has a simple value.

valuePeriod Period? - The information determined as a result of making the observation, if the information has a simple value.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[]? - A code that classifies the general type of observation being made.

device Reference? - The device used to generate the observation data.

effectiveInstant instant? - The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the 'physiologically relevant time'. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.

status ObservationStatusOne - The status of the result value.

never... - Rest field

health.fhir.r4: observation_vitalsigns

FHIR observation-vitalsigns resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_OBSERVATION_VITALSIGNS(default RESOURCE_NAME_OBSERVATION_VITALSIGNS) - The type of the resource describes

meta Baseobservation_vitalsignsMeta(default { profile : [PROFILE_BASE_OBSERVATION_VITALSIGNS] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

valueBoolean boolean? - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.value[x] is missing.

note Annotation[]? - Comments about the observation or the results.

partOf Reference[]? - A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

extension Extension[]? - 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.

valueTime time? - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

code CodeableConcept - Coded Responses from C-CDA Vital Sign Results.

subject Reference - The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus element or the code itself specifies the actual focus of the observation.

valueRange Range? - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

modifierExtension Extension[]? - 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).

focus Reference[]? - The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.

language code? - The base language in which the resource is written.

valueCodeableConcept CodeableConcept? - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

valueRatio Ratio? - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

specimen Reference? - The specimen that was used when this observation was made.

derivedFrom Reference[]? - The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.

valueDateTime dateTime? - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issued instant? - The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

valueInteger integer? - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

basedOn Reference[]? - A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.

valueQuantity Quantity? - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

identifier Identifier[]? - A unique identifier assigned to this observation.

performer Reference[]? - Who was responsible for asserting the observed value as 'true'.

effectivePeriod Period - Often just a dateTime for Vital Signs.

method CodeableConcept? - Indicates the mechanism used to perform the observation.

hasMember Reference[]? - Used when reporting vital signs panel components.

encounter Reference? - The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

bodySite CodeableConcept? - Indicates the site on the subject's body where the observation was made (i.e. the target site).

component ObservationComponent[]? - Used when reporting systolic and diastolic blood pressure.

contained Resource[]? - 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.

referenceRange ObservationReferenceRange[]? - Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an 'OR'. In other words, to represent two distinct target populations, two referenceRange elements would be used.

valueString string? - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

effectiveDateTime dateTime - Often just a dateTime for Vital Signs.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData SampledData? - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

valuePeriod Period? - Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

category CodeableConcept[] - A code that classifies the general type of observation being made.

device Reference? - The device used to generate the observation data.

status ObservationStatus - The status of the result value.

never... - Rest field

health.fhir.r4: ObservationComponent

Closed record

FHIR ObservationComponent datatype record.

Fields

valueBoolean boolean? - Vital Sign Value recorded with UCUM.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - 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.

valueTime time? - Vital Sign Value recorded with UCUM.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueRange Range? - Vital Sign Value recorded with UCUM.

modifierExtension Extension[]? - 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).

valueCodeableConcept CodeableConcept? - Vital Sign Value recorded with UCUM.

valueRatio Ratio? - Vital Sign Value recorded with UCUM.

valueString string? - Vital Sign Value recorded with UCUM.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData SampledData? - Vital Sign Value recorded with UCUM.

valuePeriod Period? - Vital Sign Value recorded with UCUM.

valueDateTime dateTime? - Vital Sign Value recorded with UCUM.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer? - Vital Sign Value recorded with UCUM.

valueQuantity Quantity? - Vital Sign Value recorded with UCUM.

health.fhir.r4: ObservationComponentOne

Closed record

FHIR ObservationComponentOne datatype record.

Fields

valueBoolean boolean? - The information determined as a result of making the observation, if the information has a simple value.

dataAbsentReason CodeableConcept? - Provides a reason why the expected value in the element Observation.component.value[x] is missing.

extension Extension[]? - 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.

valueTime time? - The information determined as a result of making the observation, if the information has a simple value.

code CodeableConcept - Describes what was observed. Sometimes this is called the observation 'code'.

valueRange Range? - The information determined as a result of making the observation, if the information has a simple value.

modifierExtension Extension[]? - 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).

valueCodeableConcept CodeableConcept? - The information determined as a result of making the observation, if the information has a simple value.

valueRatio Ratio? - The information determined as a result of making the observation, if the information has a simple value.

valueString string? - The information determined as a result of making the observation, if the information has a simple value.

interpretation CodeableConcept[]? - A categorical assessment of an observation value. For example, high, low, normal.

valueSampledData SampledData? - The information determined as a result of making the observation, if the information has a simple value.

valuePeriod Period? - The information determined as a result of making the observation, if the information has a simple value.

valueDateTime dateTime? - The information determined as a result of making the observation, if the information has a simple value.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer? - The information determined as a result of making the observation, if the information has a simple value.

valueQuantity Quantity? - The information determined as a result of making the observation, if the information has a simple value.

health.fhir.r4: ObservationDefinition

FHIR ObservationDefinition resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_OBSERVATIONDEFINITION(default RESOURCE_NAME_OBSERVATIONDEFINITION) - The type of the resource describes

meta BaseObservationDefinitionMeta(default { profile : [PROFILE_BASE_OBSERVATIONDEFINITION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

identifier Identifier[]? - A unique identifier assigned to this ObservationDefinition artifact.

extension Extension[]? - 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.

code CodeableConcept - Describes what will be observed. Sometimes this is called the observation 'name'.

validCodedValueSet Reference? - The set of valid coded results for the observations conforming to this ObservationDefinition.

method CodeableConcept? - The method or technique used to perform the observation.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

preferredReportName string? - The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.

multipleResultsAllowed boolean? - Multiple results allowed for observations conforming to this ObservationDefinition.

permittedDataType ObservationDefinitionPermittedDataType[]? - The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.

criticalCodedValueSet Reference? - The set of critical coded results for the observation conforming to this ObservationDefinition.

contained Resource[]? - 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.

normalCodedValueSet Reference? - The set of normal coded results for the observations conforming to this ObservationDefinition.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

quantitativeDetails ObservationDefinitionQuantitativeDetails? - Characteristics for quantitative results of this observation.

qualifiedInterval ObservationDefinitionQualifiedInterval[]? - Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

category CodeableConcept[]? - A code that classifies the general type of observation.

abnormalCodedValueSet Reference? - The set of abnormal coded results for the observation conforming to this ObservationDefinition.

never... - Rest field

health.fhir.r4: ObservationDefinitionQualifiedInterval

Closed record

FHIR ObservationDefinitionQualifiedInterval datatype record.

Fields

gestationalAge Range? - The gestational age to which this reference range is applicable, in the context of pregnancy.

condition string? - Text based condition for which the reference range is valid.

extension Extension[]? - 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.

gender ObservationDefinitionQualifiedIntervalGender? - Sex of the population the range applies to.

modifierExtension Extension[]? - 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).

context CodeableConcept? - Codes to indicate the health context the range applies to. For example, the normal or therapeutic range.

appliesTo CodeableConcept[]? - Codes to indicate the target population this reference range applies to.

range Range? - The low and high values determining the interval. There may be only one of the two.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category ObservationDefinitionQualifiedIntervalCategory? - The category of interval of values for continuous or ordinal observations conforming to this ObservationDefinition.

age Range? - The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.

health.fhir.r4: ObservationDefinitionQuantitativeDetails

Closed record

FHIR ObservationDefinitionQuantitativeDetails datatype record.

Fields

extension Extension[]? - 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.

unit CodeableConcept? - SI unit used to report quantitative results of observations conforming to this ObservationDefinition.

conversionFactor decimal? - Factor for converting value expressed with SI unit to value expressed with customary unit.

modifierExtension Extension[]? - 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).

customaryUnit CodeableConcept? - Customary unit used to report quantitative results of observations conforming to this ObservationDefinition.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

decimalPrecision integer? - Number of digits after decimal separator when the results of such observations are of type Quantity.

health.fhir.r4: ObservationReferenceRange

Closed record

FHIR ObservationReferenceRange datatype record.

Fields

extension Extension[]? - 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.

high Quantity? - The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).

low Quantity? - The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).

modifierExtension Extension[]? - 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).

appliesTo CodeableConcept[]? - Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of 'Negative' or a list or table of 'normals'.

'type CodeableConcept? - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

age Range? - The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.

health.fhir.r4: ObservationReferenceRangeOne

Closed record

FHIR ObservationReferenceRangeOne datatype record.

Fields

extension Extension[]? - 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.

high Quantity? - The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).

low Quantity? - The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).

modifierExtension Extension[]? - 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).

appliesTo CodeableConcept[]? - Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple appliesTo are interpreted as an 'AND' of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of 'Negative' or a list or table of 'normals'.

'type CodeableConcept? - Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

age Range? - The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.

health.fhir.r4: OidExtension

Closed record

Fields

url uri -

valueOid oid -

health.fhir.r4: OperationConfig

Closed record

Operation configuration.

Fields

namereadonly string - Name of the operation

activereadonly boolean - Is this operation is activated or deactivated

preProcessor readonly & OperationPreProcessor? - Override this operation pre-processing function. If the integration developer wants to take control of pre-processing the operation.

postProcessor readonly & OperationPostProcessor? - Override this operation post-processing function. If the integration developer wants to take control of post-processing the operation.

informationreadonly Information? - Meta infomation about the operation (no processed, just for information)

health.fhir.r4: OperationDefinition

FHIR OperationDefinition resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_OPERATIONDEFINITION(default RESOURCE_NAME_OPERATIONDEFINITION) - The type of the resource describes

meta BaseOperationDefinitionMeta(default { profile : [PROFILE_BASE_OPERATIONDEFINITION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime? - The date (and optionally time) when the operation definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the operation definition changes.

extension Extension[]? - 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.

code code - The name used to invoke the operation.

instance boolean - Indicates whether this operation can be invoked on a particular instance of one of the given types.

purpose markdown? - Explanation of why this operation definition is needed and why it has been designed as it has.

jurisdiction CodeableConcept[]? - A legal or geographic region in which the operation definition is intended to be used.

modifierExtension Extension[]? - 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).

description markdown? - A free text natural language description of the operation definition from a consumer's perspective.

experimental boolean? - A Boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language code? - The base language in which the resource is written.

title string? - A short, descriptive, user-friendly title for the operation definition.

'type boolean - Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a specific resource id for the context).

contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.

'parameter OperationDefinitionParameter[]? - The parameters for the operation/query.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

'resource code[]? - The types on which this operation can be executed.

inputProfile canonical? - Additional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole.

kind OperationDefinitionKind - Whether this is an operation or a named query.

affectsState boolean? - Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.

'version string? - The identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

overload OperationDefinitionOverload[]? - Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.

url uri? - An absolute URI that is used to identify this operation definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this operation definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the operation definition is stored on different servers.

outputProfile canonical? - Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.

contained Resource[]? - 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.

system boolean - Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).

name string - A natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher string? - The name of the organization or individual that published the operation definition.

comment markdown? - Additional information about how to use this operation or named query.

useContext UsageContext[]? - 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 operation definition instances.

base canonical? - Indicates that this operation definition is a constraining profile on the base.

status OperationDefinitionStatus - The status of this operation definition. Enables tracking the life-cycle of the content.

never... - Rest field

health.fhir.r4: OperationDefinitionOverload

Closed record

FHIR OperationDefinitionOverload datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

comment string? - Comments to go on overload.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

parameterName string[]? - Name of parameter to include in overload.

health.fhir.r4: OperationDefinitionParameter

Closed record

FHIR OperationDefinitionParameter datatype record.

Fields

extension Extension[]? - 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.

max string - The maximum number of times this element is permitted to appear in the request or response.

searchType OperationDefinitionParameterSearchType? - How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.

use OperationDefinitionParameterUse - Whether this is an input or an output parameter.

documentation string? - Describes the meaning or use of this parameter.

modifierExtension Extension[]? - 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).

binding OperationDefinitionParameterBinding? - Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).

'type code? - The type for this parameter.

referencedFrom OperationDefinitionParameterReferencedFrom[]? - Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.

min integer - The minimum number of times this parameter SHALL appear in the request or response.

name code - The name of used to identify the parameter.

targetProfile canonical[]? - Used when the type is 'Reference' or 'canonical', and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: OperationDefinitionParameterBinding

Closed record

FHIR OperationDefinitionParameterBinding datatype record.

Fields

extension Extension[]? - 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.

valueSet canonical - Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.

strength OperationDefinitionParameterBindingStrength - Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: OperationDefinitionParameterReferencedFrom

Closed record

FHIR OperationDefinitionParameterReferencedFrom datatype record.

Fields

sourceId string? - The id of the element in the referencing resource that is expected to resolve to this resource.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'source string - The name of the parameter or dot-separated path of parameter names pointing to the resource parameter that is expected to contain a reference to this resource.

health.fhir.r4: OperationOutcome

FHIR OperationOutcome resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_OPERATIONOUTCOME(default RESOURCE_NAME_OPERATIONOUTCOME) - The type of the resource describes

meta BaseOperationOutcomeMeta(default { profile : [PROFILE_BASE_OPERATIONOUTCOME] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

contained Resource[]? - 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.

extension Extension[]? - 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.

issue OperationOutcomeIssue[] - An error, warning, or information message that results from a system action.

modifierExtension Extension[]? - 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).

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

language code? - The base language in which the resource is written.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

never... - Rest field

health.fhir.r4: OperationOutcomeIssue

Closed record

FHIR OperationOutcomeIssue datatype record.

Fields

severity OperationOutcomeIssueSeverity - Indicates whether the issue indicates a variation from successful processing.

diagnostics string? - Additional diagnostic information about the issue.

extension Extension[]? - 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.

code code - Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.

expression string[]? - A simple subset of FHIRPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.

modifierExtension Extension[]? - 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).

details CodeableConcept? - Additional details about the error. This may be a text description of the error or a system code that identifies the error.

location string[]? - This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse. For resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be 'http.' + the parameter name.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: Organization

FHIR Organization resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_ORGANIZATION(default RESOURCE_NAME_ORGANIZATION) - The type of the resource describes

meta BaseOrganizationMeta(default { profile : [PROFILE_BASE_ORGANIZATION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

identifier Identifier[]? - Identifier for the organization that is used to identify the organization across multiple disparate systems.

partOf Reference? - The organization of which this organization forms a part.

extension Extension[]? - 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.

address Address[]? - An address for the organization.

modifierExtension Extension[]? - 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).

active boolean? - Whether the organization's record is still in active use.

language code? - The base language in which the resource is written.

'type CodeableConcept[]? - The kind(s) of organization that this is.

contained Resource[]? - 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.

endpoint Reference[]? - Technical endpoints providing access to services operated for the organization.

contact OrganizationContact[]? - Contact for the organization for a certain purpose.

name string? - A name associated with the organization.

alias string[]? - A list of alternate names that the organization is known as, or was known as in the past.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

telecom ContactPoint[]? - A contact detail for the organization.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

never... - Rest field

health.fhir.r4: OrganizationAffiliation

FHIR OrganizationAffiliation resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_ORGANIZATIONAFFILIATION(default RESOURCE_NAME_ORGANIZATIONAFFILIATION) - The type of the resource describes

meta BaseOrganizationAffiliationMeta(default { profile : [PROFILE_BASE_ORGANIZATIONAFFILIATION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

identifier Identifier[]? - Business identifiers that are specific to this role.

extension Extension[]? - 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.

period Period? - The period during which the participatingOrganization is affiliated with the primary organization.

specialty CodeableConcept[]? - Specific specialty of the participatingOrganization in the context of the role.

code CodeableConcept[]? - Definition of the role the participatingOrganization plays in the association.

modifierExtension Extension[]? - 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).

active boolean? - Whether this organization affiliation record is in active use.

language code? - The base language in which the resource is written.

network Reference[]? - Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined).

contained Resource[]? - 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.

endpoint Reference[]? - Technical endpoints providing access to services operated for this role.

healthcareService Reference[]? - Healthcare services provided through the role.

organization Reference? - Organization where the role is available (primary organization/has members).

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

participatingOrganization Reference? - The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of).

location Reference[]? - The location(s) at which the role occurs.

telecom ContactPoint[]? - Contact details at the participatingOrganization relevant to this Affiliation.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

never... - Rest field

health.fhir.r4: OrganizationContact

Closed record

FHIR OrganizationContact datatype record.

Fields

extension Extension[]? - 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.

address Address? - Visiting or postal addresses for the contact.

purpose CodeableConcept? - Indicates a purpose for which the contact can be reached.

modifierExtension Extension[]? - 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).

name HumanName? - A name associated with the contact.

telecom ContactPoint[]? - A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ParameterDefinition

Closed record

Definition of a parameter to a module.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for the element within a resource (for internal references)

extension Extension[]? - Additional Content defined by implementations

name code? - Name used to access the parameter value

use ParameterDefinitionUse - in | out

min integer? - Minimum cardinality

max string? - Maximum cardinality (a number of *)

documentation string? - A brief description of the parameter

'type code - What type of value

profile canonical? - What profile the value is expected to be

health.fhir.r4: ParameterDefinitionExtension

Closed record

Fields

url uri -

valueParameterDefinition ParameterDefinition -

health.fhir.r4: Parameters

FHIR Parameters resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_PARAMETERS(default RESOURCE_NAME_PARAMETERS) - The type of the resource describes

meta BaseParametersMeta(default { profile : [PROFILE_BASE_PARAMETERS] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

'parameter ParametersParameter[]? - A parameter passed to or received from the operation.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

language code? - The base language in which the resource is written.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

never... - Rest field

health.fhir.r4: ParametersParameter

Closed record

FHIR ParametersParameter datatype record.

Fields

valueTime time? - If the parameter is a data type.

valueTriggerDefinition TriggerDefinition? - If the parameter is a data type.

valueMoney Money? - If the parameter is a data type.

valueSignature Signature? - If the parameter is a data type.

modifierExtension Extension[]? - 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).

valueUuid uuid? - If the parameter is a data type.

valueRatio Ratio? - If the parameter is a data type.

valueParameterDefinition ParameterDefinition? - If the parameter is a data type.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer? - If the parameter is a data type.

valueUnsignedInt unsignedInt? - If the parameter is a data type.

valueQuantity Quantity? - If the parameter is a data type.

valueCanonical canonical? - If the parameter is a data type.

valueCount Count? - If the parameter is a data type.

valueId id? - If the parameter is a data type.

'resource Resource? - If the parameter is a whole resource.

valueCode code? - If the parameter is a data type.

valueAddress Address? - If the parameter is a data type.

valueContactPoint ContactPoint? - If the parameter is a data type.

valuePeriod Period? - If the parameter is a data type.

valueSampledData SampledData? - If the parameter is a data type.

valueTiming Timing? - If the parameter is a data type.

name string - The name of the parameter (reference to the operation definition).

valueInstant instant? - If the parameter is a data type.

valueAge Age? - If the parameter is a data type.

valueDosage Dosage? - If the parameter is a data type.

valueBase64Binary base64Binary? - If the parameter is a data type.

valueBoolean boolean? - If the parameter is a data type.

valueCoding Coding? - If the parameter is a data type.

extension Extension[]? - 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.

valueIdentifier Identifier? - If the parameter is a data type.

valueExpression Expression? - If the parameter is a data type.

valueReference Reference? - If the parameter is a data type.

valueRange Range? - If the parameter is a data type.

valueUri uri? - If the parameter is a data type.

valueDistance Distance? - If the parameter is a data type.

valueUrl urlType? - If the parameter is a data type.

valueContactDetail ContactDetail? - If the parameter is a data type.

valueMeta Meta? - If the parameter is a data type.

valueCodeableConcept CodeableConcept? - If the parameter is a data type.

valueMarkdown markdown? - If the parameter is a data type.

valueAttachment Attachment? - If the parameter is a data type.

valueUsageContext UsageContext? - If the parameter is a data type.

valueDateTime dateTime? - If the parameter is a data type.

valueHumanName HumanName? - If the parameter is a data type.

valueRelatedArtifact RelatedArtifact? - If the parameter is a data type.

valueDecimal decimal? - If the parameter is a data type.

valueDate date? - If the parameter is a data type.

valueOid oid? - If the parameter is a data type.

valueContributor Contributor? - If the parameter is a data type.

valueString string? - If the parameter is a data type.

valuePositiveInt positiveInt? - If the parameter is a data type.

valueDuration Duration? - If the parameter is a data type.

valueDataRequirement DataRequirement? - If the parameter is a data type.

valueAnnotation Annotation? - If the parameter is a data type.

health.fhir.r4: Patient

FHIR Patient resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_PATIENT(default RESOURCE_NAME_PATIENT) - The type of the resource describes

meta BasePatientMeta(default { profile : [PROFILE_BASE_PATIENT] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

extension Extension[]? - 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.

gender PatientGender? - Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.

modifierExtension Extension[]? - 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).

link PatientLink[]? - Link to another patient resource that concerns the same actual patient.

language code? - The base language in which the resource is written.

contact PatientContact[]? - A contact party (e.g. guardian, partner, friend) for the patient.

deceasedDateTime dateTime? - Indicates if the individual is deceased or not.

generalPractitioner Reference[]? - Patient's nominated care provider.

telecom ContactPoint[]? - A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

communication PatientCommunication[]? - A language which may be used to communicate with the patient about his or her health.

identifier Identifier[]? - An identifier for this patient.

address Address[]? - An address for the individual.

multipleBirthBoolean boolean? - Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

active boolean? - Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

photo Attachment[]? - Image of the patient.

birthDate date? - The date of birth for the individual.

contained Resource[]? - 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.

deceasedBoolean boolean? - Indicates if the individual is deceased or not.

managingOrganization Reference? - Organization that is the custodian of the patient record.

multipleBirthInteger integer? - Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

name HumanName[]? - A name associated with the individual.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

maritalStatus CodeableConcept? - This field contains a patient's most recent marital (civil) status.

never... - Rest field

health.fhir.r4: PatientCommunication

Closed record

FHIR PatientCommunication datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

language CodeableConcept - The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. 'en' for English, or 'en-US' for American English versus 'en-EN' for England English.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

preferred boolean? - Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

health.fhir.r4: PatientContact

Closed record

FHIR PatientContact datatype record.

Fields

extension Extension[]? - 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.

period Period? - The period during which this contact person or organization is valid to be contacted relating to this patient.

address Address? - Address for the contact person.

gender PatientContactGender? - Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.

modifierExtension Extension[]? - 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).

organization Reference? - Organization on behalf of which the contact is acting or for which the contact is working.

name HumanName? - A name associated with the contact person.

telecom ContactPoint[]? - A contact detail for the person, e.g. a telephone number or an email address.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

relationship CodeableConcept[]? - The nature of the relationship between the patient and the contact person.

health.fhir.r4: PatientLink

Closed record

FHIR PatientLink datatype record.

Fields

extension Extension[]? - 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.

other Reference - The other patient resource that the link refers to.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type PatientLinkType - The type of link between this patient resource and another patient resource.

health.fhir.r4: PaymentNotice

FHIR PaymentNotice resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_PAYMENTNOTICE(default RESOURCE_NAME_PAYMENTNOTICE) - The type of the resource describes

meta BasePaymentNoticeMeta(default { profile : [PROFILE_BASE_PAYMENTNOTICE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

identifier Identifier[]? - A unique identifier assigned to this payment notice.

request Reference? - Reference of resource for which payment is being made.

amount Money - The amount sent to the payee.

extension Extension[]? - 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.

created dateTime - The date when this resource was created.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

payee Reference? - The party who will receive or has received payment that is the subject of this notification.

contained Resource[]? - 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.

provider Reference? - The practitioner who is responsible for the services rendered to the patient.

response Reference? - Reference of response to resource for which payment is being made.

recipient Reference - The party who is notified of the payment status.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

payment Reference - A reference to the payment which is the subject of this notice.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

paymentDate date? - The date when the above payment action occurred.

paymentStatus CodeableConcept? - A code indicating whether payment has been sent or cleared.

status PaymentNoticeStatus - The status of the resource instance.

never... - Rest field

health.fhir.r4: PaymentReconciliation

FHIR PaymentReconciliation resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_PAYMENTRECONCILIATION(default RESOURCE_NAME_PAYMENTRECONCILIATION) - The type of the resource describes

meta BasePaymentReconciliationMeta(default { profile : [PROFILE_BASE_PAYMENTRECONCILIATION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

identifier Identifier[]? - A unique identifier assigned to this payment reconciliation.

request Reference? - Original request resource reference.

extension Extension[]? - 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.

period Period? - The period of time for which payments have been gathered into this bulk payment for settlement.

formCode CodeableConcept? - A code for the form to be used for printing the content.

created dateTime - The date when the resource was created.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

paymentAmount Money - Total payment amount as indicated on the financial instrument.

processNote PaymentReconciliationProcessNote[]? - A note that describes or explains the processing in a human readable form.

requestor Reference? - The practitioner who is responsible for the services rendered to the patient.

paymentIssuer Reference? - The party who generated the payment.

contained Resource[]? - 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.

disposition string? - A human readable description of the status of the request for the reconciliation.

paymentIdentifier Identifier? - Issuer's unique identifier for the payment instrument.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

detail PaymentReconciliationDetail[]? - Distribution of the payment amount for a previously acknowledged payable.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

paymentDate date - The date of payment as indicated on the financial instrument.

outcome PaymentReconciliationOutcome? - The outcome of a request for a reconciliation.

status PaymentReconciliationStatus - The status of the resource instance.

never... - Rest field

health.fhir.r4: PaymentReconciliationDetail

Closed record

FHIR PaymentReconciliationDetail datatype record.

Fields

date date? - The date from the response resource containing a commitment to pay.

identifier Identifier? - Unique identifier for the current payment item for the referenced payable.

request Reference? - A resource, such as a Claim, the evaluation of which could lead to payment.

submitter Reference? - The party which submitted the claim or financial transaction.

amount Money? - The monetary amount allocated from the total payment to the payable.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

predecessor Identifier? - Unique identifier for the prior payment item for the referenced payable.

'type CodeableConcept - Code to indicate the nature of the payment.

payee Reference? - The party which is receiving the payment.

response Reference? - A resource, such as a ClaimResponse, which contains a commitment to payment.

responsible Reference? - A reference to the individual who is responsible for inquiries regarding the response and its payment.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: PaymentReconciliationProcessNote

Closed record

FHIR PaymentReconciliationProcessNote datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - The explanation or description associated with the processing.

'type PaymentReconciliationProcessNoteType? - The business purpose of the note text.

health.fhir.r4: Period

Closed record

A time period defined by a start and end date/time.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

'start dateTime? - Starting time with inclusive boundary

end dateTime? - End time with inclusive boundary, if not ongoing

health.fhir.r4: PeriodExtension

Closed record

Fields

url uri -

valuePeriod Period -

health.fhir.r4: Person

FHIR Person resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_PERSON(default RESOURCE_NAME_PERSON) - The type of the resource describes

meta BasePersonMeta(default { profile : [PROFILE_BASE_PERSON] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

identifier Identifier[]? - Identifier for a person within a particular scope.

extension Extension[]? - 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.

address Address[]? - One or more addresses for the person.

gender PersonGender? - Administrative Gender.

modifierExtension Extension[]? - 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).

link PersonLink[]? - Link to a resource that concerns the same actual person.

active boolean? - Whether this person's record is in active use.

photo Attachment? - An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.

language code? - The base language in which the resource is written.

birthDate date? - The birth date for the person.

contained Resource[]? - 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.

managingOrganization Reference? - The organization that is the custodian of the person record.

name HumanName[]? - A name associated with the person.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

telecom ContactPoint[]? - A contact detail for the person, e.g. a telephone number or an email address.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

never... - Rest field

health.fhir.r4: PersonLink

Closed record

FHIR PersonLink datatype record.

Fields

assurance PersonLinkAssurance? - Level of assurance that this link is associated with the target resource.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

target Reference - The resource to which this actual person is associated.

health.fhir.r4: PlanDefinition

FHIR PlanDefinition resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_PLANDEFINITION(default RESOURCE_NAME_PLANDEFINITION) - The type of the resource describes

meta BasePlanDefinitionMeta(default { profile : [PROFILE_BASE_PLANDEFINITION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime? - The date (and optionally time) when the plan definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.

copyright markdown? - A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.

extension Extension[]? - 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.

approvalDate date? - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

subjectCodeableConcept CodeableConcept? - A code or group definition that describes the intended subject of the plan definition.

purpose markdown? - Explanation of why this plan definition is needed and why it has been designed as it has.

jurisdiction CodeableConcept[]? - A legal or geographic region in which the plan definition is intended to be used.

modifierExtension Extension[]? - 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).

usage string? - A detailed description of how the plan definition is used from a clinical perspective.

description markdown? - A free text natural language description of the plan definition from a consumer's perspective.

experimental boolean? - A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language code? - The base language in which the resource is written.

title string? - A short, descriptive, user-friendly title for the plan definition.

'type CodeableConcept? - A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.

library canonical[]? - A reference to a Library resource containing any formal logic used by the plan definition.

contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.

endorser ContactDetail[]? - An individual or organization responsible for officially endorsing the content for use in some setting.

action PlanDefinitionAction[]? - An action or group of actions to be taken as part of the plan.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

editor ContactDetail[]? - An individual or organization primarily responsible for internal coherence of the content.

identifier Identifier[]? - 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.

goal PlanDefinitionGoal[]? - 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.

relatedArtifact RelatedArtifact[]? - Related artifacts such as additional documentation, justification, or bibliographic references.

effectivePeriod Period? - The period during which the plan definition content was or is planned to be in active use.

author ContactDetail[]? - An individiual or organization primarily involved in the creation and maintenance of the content.

reviewer ContactDetail[]? - An individual or organization primarily responsible for review of some aspect of the content.

subjectReference Reference? - A code or group definition that describes the intended subject of the plan definition.

'version string? - The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.

url uri? - An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.

contained Resource[]? - 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.

lastReviewDate date? - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

subtitle string? - An explanatory or alternate title for the plan definition giving additional information about its content.

name string? - A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher string? - The name of the organization or individual that published the plan definition.

topic CodeableConcept[]? - 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.

useContext UsageContext[]? - 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.

status PlanDefinitionStatus - The status of this plan definition. Enables tracking the life-cycle of the content.

never... - Rest field

health.fhir.r4: PlanDefinitionAction

Closed record

FHIR PlanDefinitionAction datatype record.

Fields

reason CodeableConcept[]? - A description of why this action is necessary or appropriate.

cardinalityBehavior PlanDefinitionActionCardinalityBehavior? - Defines whether the action can be selected multiple times.

definitionCanonical canonical? - 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.

extension Extension[]? - 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.

code CodeableConcept[]? - 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.

goalId id[]? - Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.

subjectCodeableConcept CodeableConcept? - A code or group definition that describes the intended subject of the action and its children, if any.

prefix string? - A user-visible prefix for the action.

modifierExtension Extension[]? - 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).

description string? - A brief description of the action used to provide a summary to display to the user.

definitionUri uri? - 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.

title string? - The title of the action displayed to a user.

'type CodeableConcept? - The type of action to perform (create, update, remove).

groupingBehavior PlanDefinitionActionGroupingBehavior? - Defines the grouping behavior for the action and its children.

participant PlanDefinitionActionParticipant[]? - Indicates who should participate in performing the action described.

output DataRequirement[]? - Defines the outputs of the action, if any.

transform canonical? - A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

dynamicValue PlanDefinitionActionDynamicValue[]? - 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.

timingAge Age? - An optional value describing when the action should be performed.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

relatedAction PlanDefinitionActionRelatedAction[]? - A relationship to another action such as 'before' or '30-60 minutes after start of'.

timingDuration Duration? - An optional value describing when the action should be performed.

textEquivalent string? - A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.

timingTiming Timing? - An optional value describing when the action should be performed.

timingPeriod Period? - An optional value describing when the action should be performed.

documentation RelatedArtifact[]? - 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.

trigger TriggerDefinition[]? - A description of when the action should be triggered.

priority PlanDefinitionActionPriority? - Indicates how quickly the action should be addressed with respect to other actions.

subjectReference Reference? - A code or group definition that describes the intended subject of the action and its children, if any.

input DataRequirement[]? - Defines input data requirements for the action.

requiredBehavior PlanDefinitionActionRequiredBehavior? - Defines the required behavior for the action.

condition PlanDefinitionActionCondition[]? - An expression that describes applicability criteria or start/stop conditions for the action.

selectionBehavior PlanDefinitionActionSelectionBehavior? - Defines the selection behavior for the action and its children.

timingRange Range? - An optional value describing when the action should be performed.

precheckBehavior PlanDefinitionActionPrecheckBehavior? - Defines whether the action should usually be preselected.

timingDateTime dateTime? - An optional value describing when the action should be performed.

health.fhir.r4: PlanDefinitionActionCondition

Closed record

FHIR PlanDefinitionActionCondition datatype record.

Fields

extension Extension[]? - 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.

expression Expression? - An expression that returns true or false, indicating whether the condition is satisfied.

kind PlanDefinitionActionConditionKind - The kind of condition.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: PlanDefinitionActionDynamicValue

Closed record

FHIR PlanDefinitionActionDynamicValue datatype record.

Fields

path string? - The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

extension Extension[]? - 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.

expression Expression? - An expression specifying the value of the customized element.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: PlanDefinitionActionParticipant

Closed record

FHIR PlanDefinitionActionParticipant datatype record.

Fields

extension Extension[]? - 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.

role CodeableConcept? - The role the participant should play in performing the described action.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type PlanDefinitionActionParticipantType - The type of participant in the action.

health.fhir.r4: PlanDefinitionActionRelatedAction

Closed record

FHIR PlanDefinitionActionRelatedAction datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

actionId id - The element id of the related action.

offsetDuration Duration? - A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

offsetRange Range? - A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

relationship PlanDefinitionActionRelatedActionRelationship - The relationship of this action to the related action.

health.fhir.r4: PlanDefinitionGoal

Closed record

FHIR PlanDefinitionGoal datatype record.

Fields

addresses CodeableConcept[]? - Identifies problems, conditions, issues, or concerns the goal is intended to address.

extension Extension[]? - 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.

documentation RelatedArtifact[]? - 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.

modifierExtension Extension[]? - 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).

'start CodeableConcept? - The event after which the goal should begin being pursued.

description CodeableConcept - Human-readable and/or coded description of a specific desired objective of care, such as 'control blood pressure' or 'negotiate an obstacle course' or 'dance with child at wedding'.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

category CodeableConcept? - Indicates a category the goal falls within.

priority CodeableConcept? - Identifies the expected level of importance associated with reaching/sustaining the defined goal.

target PlanDefinitionGoalTarget[]? - Indicates what should be done and within what timeframe.

health.fhir.r4: PlanDefinitionGoalTarget

Closed record

FHIR PlanDefinitionGoalTarget datatype record.

Fields

detailRange Range? - The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

extension Extension[]? - 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.

measure CodeableConcept? - The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.

due Duration? - Indicates the timeframe after the start of the goal in which the goal should be met.

detailQuantity Quantity? - The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

modifierExtension Extension[]? - 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).

detailCodeableConcept CodeableConcept? - The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: Population

Closed record

A definition of a set of people that apply to some clinically related context, for example people contraindicated for a certain medication.

Fields

Fields Included from *BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

modifierExtension Extension[]? - Extensions that cannot be ignored even if unrecognized

ageRange Range? - The age range of the specific population

ageCodeableConcept CodeableConcept? - The age concept of the specific population

gender CodeableConcept? - The gender of the specific population

race CodeableConcept? - Race of the specific population

physiologicalCondition CodeableConcept? - The existing physiological conditions of the specific population to which this applies

health.fhir.r4: PositiveIntExtension

Closed record

Fields

url uri -

valuePositiveInt positiveInt -

health.fhir.r4: Practitioner

FHIR Practitioner resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_PRACTITIONER(default RESOURCE_NAME_PRACTITIONER) - The type of the resource describes

meta BasePractitionerMeta(default { profile : [PROFILE_BASE_PRACTITIONER] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

identifier Identifier[]? - An identifier that applies to this person in this role.

extension Extension[]? - 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.

address Address[]? - Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.

gender PractitionerGender? - Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

modifierExtension Extension[]? - 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).

active boolean? - Whether this practitioner's record is in active use.

photo Attachment[]? - Image of the person.

language code? - The base language in which the resource is written.

birthDate date? - The date of birth for the practitioner.

qualification PractitionerQualification[]? - The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.

contained Resource[]? - 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.

name HumanName[]? - The name(s) associated with the practitioner.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

telecom ContactPoint[]? - A contact detail for the practitioner, e.g. a telephone number or an email address.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

communication CodeableConcept[]? - A language the practitioner can use in patient communication.

never... - Rest field

health.fhir.r4: PractitionerQualification

Closed record

FHIR PractitionerQualification datatype record.

Fields

identifier Identifier[]? - An identifier that applies to this person's qualification in this role.

extension Extension[]? - 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.

period Period? - Period during which the qualification is valid.

code CodeableConcept - Coded representation of the qualification.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

issuer Reference? - Organization that regulates and issues the qualification.

health.fhir.r4: PractitionerRole

FHIR PractitionerRole resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_PRACTITIONERROLE(default RESOURCE_NAME_PRACTITIONERROLE) - The type of the resource describes

meta BasePractitionerRoleMeta(default { profile : [PROFILE_BASE_PRACTITIONERROLE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

identifier Identifier[]? - Business Identifiers that are specific to a role/location.

extension Extension[]? - 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.

period Period? - The period during which the person is authorized to act as a practitioner in these role(s) for the organization.

specialty CodeableConcept[]? - Specific specialty of the practitioner.

code CodeableConcept[]? - Roles which this practitioner is authorized to perform for the organization.

practitioner Reference? - Practitioner that is able to provide the defined services for the organization.

modifierExtension Extension[]? - 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).

active boolean? - Whether this practitioner role record is in active use.

language code? - The base language in which the resource is written.

notAvailable PractitionerRoleNotAvailable[]? - The practitioner is not available or performing this role during this period of time due to the provided reason.

availableTime PractitionerRoleAvailableTime[]? - A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.

contained Resource[]? - 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.

endpoint Reference[]? - Technical endpoints providing access to services operated for the practitioner with this role.

healthcareService Reference[]? - The list of healthcare services that this worker provides for this role's Organization/Location(s).

organization Reference? - The organization where the Practitioner performs the roles associated.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

location Reference[]? - The location(s) at which this practitioner provides care.

telecom ContactPoint[]? - Contact details that are specific to the role/location/service.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

availabilityExceptions string? - A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.

never... - Rest field

health.fhir.r4: PractitionerRoleAvailableTime

Closed record

FHIR PractitionerRoleAvailableTime datatype record.

Fields

allDay boolean? - Is this always available? (hence times are irrelevant) e.g. 24 hour service.

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

availableEndTime time? - The closing time of day. Note: If the AllDay flag is set, then this time is ignored.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

daysOfWeek PractitionerRoleAvailableTimeDaysOfWeek[]? - Indicates which days of the week are available between the start and end Times.

availableStartTime time? - The opening time of day. Note: If the AllDay flag is set, then this time is ignored.

health.fhir.r4: PractitionerRoleNotAvailable

Closed record

FHIR PractitionerRoleNotAvailable datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

description string - The reason that can be presented to the user as to why this time is not available.

during Period? - Service is not available (seasonally or for a public holiday) from this date.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: Procedure

FHIR Procedure resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_PROCEDURE(default RESOURCE_NAME_PROCEDURE) - The type of the resource describes

meta BaseProcedureMeta(default { profile : [PROFILE_BASE_PROCEDURE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

note Annotation[]? - Any other notes and comments about the procedure.

partOf Reference[]? - A larger event of which this particular procedure is a component or step.

complication CodeableConcept[]? - Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.

extension Extension[]? - 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.

code CodeableConcept? - The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. 'Laparoscopic Appendectomy').

subject Reference - The person, animal or group on which the procedure was performed.

modifierExtension Extension[]? - 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).

reasonReference Reference[]? - The justification of why the procedure was performed.

language code? - The base language in which the resource is written.

performedRange Range? - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

performedAge Age? - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

instantiatesUri uri[]? - The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.

performedPeriod Period? - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

performedString string? - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

followUp CodeableConcept[]? - If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.

statusReason CodeableConcept? - Captures the reason for the current state of the procedure.

usedCode CodeableConcept[]? - Identifies coded items that were used as part of the procedure.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

reasonCode CodeableConcept[]? - The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

performedDateTime dateTime? - Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

basedOn Reference[]? - A reference to a resource that contains details of the request for this procedure.

outcome CodeableConcept? - The outcome of the procedure - did it resolve the reasons for the procedure being performed?

identifier Identifier[]? - Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.

recorder Reference? - Individual who recorded the record and takes responsibility for its content.

complicationDetail Reference[]? - Any complications that occurred during the procedure, or in the immediate post-performance period.

performer ProcedurePerformer[]? - Limited to 'real' people rather than equipment.

usedReference Reference[]? - Identifies medications, devices and any other substance used as part of the procedure.

focalDevice ProcedureFocalDevice[]? - A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.

encounter Reference? - The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.

instantiatesCanonical canonical[]? - The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.

bodySite CodeableConcept[]? - Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.

contained Resource[]? - 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.

asserter Reference? - Individual who is making the procedure statement.

report Reference[]? - This could be a histology result, pathology report, surgical report, etc.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

location Reference? - The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.

category CodeableConcept? - A code that classifies the procedure for searching, sorting and display purposes (e.g. 'Surgical Procedure').

status ProcedureStatus - A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.

never... - Rest field

health.fhir.r4: ProcedureFocalDevice

Closed record

FHIR ProcedureFocalDevice datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

action CodeableConcept? - The kind of change that happened to the device during the procedure.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

manipulated Reference - The device that was manipulated (changed) during the procedure.

health.fhir.r4: ProcedurePerformer

Closed record

FHIR ProcedurePerformer datatype record.

Fields

actor Reference - The practitioner who was involved in the procedure.

extension Extension[]? - 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.

'function CodeableConcept? - Distinguishes the type of involvement of the performer in the procedure. For example, surgeon, anaesthetist, endoscopist.

modifierExtension Extension[]? - 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).

onBehalfOf Reference? - The organization the device or practitioner was acting on behalf of.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: ProcessingMetaInfo

Record type to hold meta information used for processing the entity.

Fields

targetModel typedesc? - target resource model or data model

relocations Mapping[]? - mappings entries from source model (this) to target model

health.fhir.r4: ProdCharacteristic

Closed record

The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.

Fields

Fields Included from *BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

modifierExtension Extension[]? - Extensions that cannot be ignored even if unrecognized

height Quantity? - height can be specified using a numerical value and its unit of measurement

width Quantity? - width can be specified using a numerical value and its unit of measurement

depth Quantity? - depth can be specified using a numerical value and its unit of measurement

weight Quantity? - weight can be specified using a numerical value and its unit of measurement

nominalValue Quantity? - nominal volume can be specified using a numerical value and its unit of measurement

externalDiameter Quantity? - Number of sample points at each time point

shape string? - shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used

color string? - color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used

imprint string? - Where applicable, the imprint can be specified as text

image Attachment? - shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used

scoring CodeableConcept? - the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used

health.fhir.r4: ProductShelfLife

Closed record

The shelf-life and storage information for a medicinal product item or container can be described using this class.

Fields

Fields Included from *BackboneElement

id string
extension Extension[]
modifierExtension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

modifierExtension Extension[]? - Additional content defined by implementations

identifier Identifier? - Unique identifier for the packaged Medicinal Product

'type CodeableConcept - This describes the shelf life, taking into account various scenarios such as shelf life of the packaged

period Quantity - The shelf life time period can be specified using a numerical value for the period of time and its unit of
time measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology
The symbol and the symbol identifier shall be used

specialPrecautionsForStorage CodeableConcept[]? - Special precautions for storage, if any, can be specified using an appropriate controlled
vocabulary The controlled term and the controlled term identifier shall be specified

health.fhir.r4: Profile

Closed record

Represents a profile, containing summary information.

Fields

url string - Canonical identifier for this structure definition, represented as a URI (globally unique)

resourceType string - FHIR resource type

modelType typedesc<anydata> - ballerina model type which is used to represent instance of this profile

health.fhir.r4: Provenance

FHIR Provenance resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_PROVENANCE(default RESOURCE_NAME_PROVENANCE) - The type of the resource describes

meta BaseProvenanceMeta(default { profile : [PROFILE_BASE_PROVENANCE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

reason CodeableConcept[]? - The reason that the activity was taking place.

agent ProvenanceAgent[] - An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.

extension Extension[]? - 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.

activity CodeableConcept? - An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.

signature Signature[]? - A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

occurredPeriod Period? - The period during which the activity occurred.

recorded instant - The instant of time at which the activity was recorded.

target Reference[] - The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.

contained Resource[]? - 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.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

location Reference? - Where the activity occurred, if relevant.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

entity ProvenanceEntity[]? - An entity used in this activity.

occurredDateTime dateTime? - The period during which the activity occurred.

policy uri[]? - Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.

never... - Rest field

health.fhir.r4: ProvenanceAgent

Closed record

FHIR ProvenanceAgent datatype record.

Fields

extension Extension[]? - 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.

role CodeableConcept[]? - The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.

modifierExtension Extension[]? - 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).

onBehalfOf Reference? - The individual, device, or organization for whom the change was made.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

'type CodeableConcept? - The participation the agent had with respect to the activity.

who Reference - The individual, device or organization that participated in the event.

health.fhir.r4: ProvenanceEntity

Closed record

FHIR ProvenanceEntity datatype record.

Fields

extension Extension[]? - 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.

role ProvenanceEntityRole - How the entity was used during the activity.

what Reference - Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: Quantity

Closed record

A measured or measurable amount Rule: If a code for the unit is present, the system SHALL also be present Elements defined in Ancestors: id, extension

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

value decimal? - Numerical value (with implicit precision)

comparator QuantityComparatorCode? - < | <= | >= | > - how to understand the value

unit string? - Unit representation

system uri? - System that defines coded unit form

code code? - Coded form of the unit

health.fhir.r4: QuantityExtension

Closed record

Fields

url uri -

valueQuantity Quantity -

health.fhir.r4: QuantitySearchParameter

A quantity parameter searches on the Quantity data type.

Fields

Fields Included from *FHIRTypedSearchParameter

modifier "text-advanced"|"text"|"of-type"|"not-in"|"not"|"missing"|"iterate"|"in"|"identifier"|"exact"|"contains"|"code-text"|"below"|"above"|string|()
anydata...

prefix readonly & Prefix? - Prefix to the parameter value may be used to control the nature of the matching

number readonly & int|float - Numerical value (with implicit precision). The number part can be a decimal in exponential format

system readonly & string? - System that defines coded unit form

code readonly & string? - Coded form of the unit

health.fhir.r4: Questionnaire

FHIR Questionnaire resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_QUESTIONNAIRE(default RESOURCE_NAME_QUESTIONNAIRE) - The type of the resource describes

meta BaseQuestionnaireMeta(default { profile : [PROFILE_BASE_QUESTIONNAIRE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime? - The date (and optionally time) when the questionnaire was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes.

copyright markdown? - A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire.

extension Extension[]? - 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.

approvalDate date? - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

code Coding[]? - An identifier for this question or group of questions in a particular terminology such as LOINC.

purpose markdown? - Explanation of why this questionnaire is needed and why it has been designed as it has.

jurisdiction CodeableConcept[]? - A legal or geographic region in which the questionnaire is intended to be used.

modifierExtension Extension[]? - 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).

description markdown? - A free text natural language description of the questionnaire from a consumer's perspective.

experimental boolean? - A Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

language code? - The base language in which the resource is written.

title string? - A short, descriptive, user-friendly title for the questionnaire.

subjectType code[]? - The types of subjects that can be the subject of responses created for the questionnaire.

contact ContactDetail[]? - Contact details to assist a user in finding and communicating with the publisher.

derivedFrom canonical[]? - The URL of a Questionnaire that this Questionnaire is based on.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

identifier Identifier[]? - A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance.

item QuestionnaireItem[]? - A particular question, question grouping or display text that is part of the questionnaire.

effectivePeriod Period? - The period during which the questionnaire content was or is planned to be in active use.

'version string? - The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

url uri? - An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this questionnaire is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the questionnaire is stored on different servers.

contained Resource[]? - 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.

lastReviewDate date? - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

name string? - A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

publisher string? - The name of the organization or individual that published the questionnaire.

useContext UsageContext[]? - 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 questionnaire instances.

status QuestionnaireStatus - The status of this questionnaire. Enables tracking the life-cycle of the content.

never... - Rest field

health.fhir.r4: QuestionnaireItem

Closed record

FHIR QuestionnaireItem datatype record.

Fields

repeats boolean? - An indication, if true, that the item may occur multiple times in the response, collecting multiple answers for questions or multiple sets of answers for groups.

extension Extension[]? - 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.

code Coding[]? - A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).

enableWhen QuestionnaireItemEnableWhen[]? - A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.

initial QuestionnaireItemInitial[]? - One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input.

prefix string? - A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.

modifierExtension Extension[]? - 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).

readOnly boolean? - An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.

'type QuestionnaireItemType - The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, coded choice, etc.).

required boolean? - An indication, if true, that the item must be present in a 'completed' QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.

linkId string - An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.

definition uri? - This element is a URI that refers to an ElementDefinition that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource. A detailed description of the construction of the URI is shown in Comments, below. If this element is present then the following element values MAY be derived from the Element Definition if the corresponding elements of this Questionnaire resource instance have no value: * code (ElementDefinition.code) * type (ElementDefinition.type) * required (ElementDefinition.min) * repeats (ElementDefinition.max) * maxLength (ElementDefinition.maxLength) * answerValueSet (ElementDefinition.binding) * options (ElementDefinition.binding).

enableBehavior QuestionnaireItemEnableBehavior? - Controls how multiple enableWhen values are interpreted - whether all or any must be true.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - The name of a section, the text of a question or text content for a display item.

answerOption QuestionnaireItemAnswerOption[]? - One of the permitted answers for a 'choice' or 'open-choice' question.

answerValueSet canonical? - A reference to a value set containing a list of codes representing permitted answers for a 'choice' or 'open-choice' question.

maxLength integer? - The maximum number of characters that are permitted in the answer to be considered a 'valid' QuestionnaireResponse.

health.fhir.r4: QuestionnaireItemAnswerOption

Closed record

FHIR QuestionnaireItemAnswerOption datatype record.

Fields

valueCoding Coding - A potential answer that's allowed as the answer to this question.

extension Extension[]? - 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.

valueTime time - A potential answer that's allowed as the answer to this question.

valueString string - A potential answer that's allowed as the answer to this question.

valueReference Reference - A potential answer that's allowed as the answer to this question.

initialSelected boolean? - Indicates whether the answer value is selected when the list of possible answers is initially shown.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueDate date - A potential answer that's allowed as the answer to this question.

valueInteger integer - A potential answer that's allowed as the answer to this question.

health.fhir.r4: QuestionnaireItemEnableWhen

Closed record

FHIR QuestionnaireItemEnableWhen datatype record.

Fields

answerQuantity Quantity - A value that the referenced question is tested using the specified operator in order for the item to be enabled.

answerDateTime dateTime - A value that the referenced question is tested using the specified operator in order for the item to be enabled.

extension Extension[]? - 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.

answerDate date - A value that the referenced question is tested using the specified operator in order for the item to be enabled.

answerTime time - A value that the referenced question is tested using the specified operator in order for the item to be enabled.

question string - The linkId for the question whose answer (or lack of answer) governs whether this item is enabled.

modifierExtension Extension[]? - 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).

answerInteger integer - A value that the referenced question is tested using the specified operator in order for the item to be enabled.

operator QuestionnaireItemEnableWhenOperator - Specifies the criteria by which the question is enabled.

answerDecimal decimal - A value that the referenced question is tested using the specified operator in order for the item to be enabled.

answerString string - A value that the referenced question is tested using the specified operator in order for the item to be enabled.

answerCoding Coding - A value that the referenced question is tested using the specified operator in order for the item to be enabled.

answerReference Reference - A value that the referenced question is tested using the specified operator in order for the item to be enabled.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

answerBoolean boolean - A value that the referenced question is tested using the specified operator in order for the item to be enabled.

health.fhir.r4: QuestionnaireItemInitial

Closed record

FHIR QuestionnaireItemInitial datatype record.

Fields

valueBoolean boolean - The actual value to for an initial answer.

valueCoding Coding - The actual value to for an initial answer.

extension Extension[]? - 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.

valueTime time - The actual value to for an initial answer.

valueReference Reference - The actual value to for an initial answer.

modifierExtension Extension[]? - 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).

valueDecimal decimal - The actual value to for an initial answer.

valueUri uri - The actual value to for an initial answer.

valueDate date - The actual value to for an initial answer.

valueAttachment Attachment - The actual value to for an initial answer.

valueString string - The actual value to for an initial answer.

valueDateTime dateTime - The actual value to for an initial answer.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer - The actual value to for an initial answer.

valueQuantity Quantity - The actual value to for an initial answer.

health.fhir.r4: QuestionnaireResponse

FHIR QuestionnaireResponse resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_QUESTIONNAIRERESPONSE(default RESOURCE_NAME_QUESTIONNAIRERESPONSE) - The type of the resource describes

meta BaseQuestionnaireResponseMeta(default { profile : [PROFILE_BASE_QUESTIONNAIRERESPONSE] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

authored dateTime? - The date and/or time that this set of answers were last changed.

identifier Identifier? - A business identifier assigned to a particular completed (or partially completed) questionnaire.

partOf Reference[]? - A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of.

extension Extension[]? - 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.

item QuestionnaireResponseItem[]? - A group or question item from the original questionnaire for which answers are provided.

questionnaire canonical? - The Questionnaire that defines and organizes the questions for which answers are being provided.

author Reference? - Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.

subject Reference? - The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information.

modifierExtension Extension[]? - 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).

language code? - The base language in which the resource is written.

encounter Reference? - The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.

'source Reference? - The person who answered the questions about the subject.

contained Resource[]? - 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.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

basedOn Reference[]? - The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.

status QuestionnaireResponseStatus - The position of the questionnaire response within its overall lifecycle.

never... - Rest field

health.fhir.r4: QuestionnaireResponseItem

Closed record

FHIR QuestionnaireResponseItem datatype record.

Fields

extension Extension[]? - 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.

linkId string - The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource.

answer QuestionnaireResponseItemAnswer[]? - The respondent's answer(s) to the question.

modifierExtension Extension[]? - 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).

definition uri? - A reference to an ElementDefinition that provides the details for the item.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

text string? - Text that is displayed above the contents of the group or as the text of the question being answered.

health.fhir.r4: QuestionnaireResponseItemAnswer

Closed record

FHIR QuestionnaireResponseItemAnswer datatype record.

Fields

valueBoolean boolean? - The answer (or one of the answers) provided by the respondent to the question.

valueCoding Coding? - The answer (or one of the answers) provided by the respondent to the question.

extension Extension[]? - 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.

valueTime time? - The answer (or one of the answers) provided by the respondent to the question.

valueReference Reference? - The answer (or one of the answers) provided by the respondent to the question.

modifierExtension Extension[]? - 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).

valueDecimal decimal? - The answer (or one of the answers) provided by the respondent to the question.

valueUri uri? - The answer (or one of the answers) provided by the respondent to the question.

valueDate date? - The answer (or one of the answers) provided by the respondent to the question.

valueAttachment Attachment? - The answer (or one of the answers) provided by the respondent to the question.

valueString string? - The answer (or one of the answers) provided by the respondent to the question.

valueDateTime dateTime? - The answer (or one of the answers) provided by the respondent to the question.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

valueInteger integer? - The answer (or one of the answers) provided by the respondent to the question.

valueQuantity Quantity? - The answer (or one of the answers) provided by the respondent to the question.

health.fhir.r4: Range

Closed record

Set of values bounded by low and high. Rule: If present, low SHALL have a lower value than high Elements defined in Ancestors: id, extension

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

low SimpleQuantity? - Low limit

high SimpleQuantity? - High limit

health.fhir.r4: RangeExtension

Closed record

Fields

url uri -

valueRange Range -

health.fhir.r4: Ratio

Closed record

A ratio of two Quantity values - a numerator and a denominator Rule: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

numerator SimpleQuantity? - Numerator value

denominator SimpleQuantity? - Denominator value

health.fhir.r4: RatioExtension

Closed record

Fields

url uri -

valueRatio Ratio -

health.fhir.r4: RatioRange

Closed record

DesRange of ratio values Rule: One of lowNumerator or highNumerator and denominator SHALL be present, or all are absent. If all are absent, there SHALL be some extension present Rule: If present, lowNumerator SHALL have a lower value than highNumerator Elements defined in Ancestors: id, extensioncription.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

highNumerator SimpleQuantity? - High Numerator value

lowNumerator SimpleQuantity? - Low Numerator value

denominator SimpleQuantity? - Denominator value

health.fhir.r4: RatioRangeExtension

Closed record

Fields

url uri -

valueRatioRange RatioRange -

health.fhir.r4: Reference

Closed record

A reference from one resource to another.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

reference string? - Literal reference, Relative, internal or absolute URL
- Rule : SHALL have a contained resource if a local reference is provided

'type string? - Type the reference refers to (e.g. Patient) ResourceType(http://hl7.org/fhir/valueset-resource-types.html) (Extensible)

identifier Identifier? - Logical reference, when literal reference is not known

display string? - Text alternative for the resource

health.fhir.r4: ReferenceExtension

Closed record

Fields

url uri -

valueReference Reference -

health.fhir.r4: ReferenceRange

Closed record

Reference range of possible or expected values

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

lowLimit Quantity? - Lower limit possible or expected

highLimit Quantity? - Upper limit possible or expected

health.fhir.r4: ReferenceSearchParameter

Reference type search parameter information.

Fields

Fields Included from *FHIRTypedSearchParameter

modifier "text-advanced"|"text"|"of-type"|"not-in"|"not"|"missing"|"iterate"|"in"|"identifier"|"exact"|"contains"|"code-text"|"below"|"above"|string|()
anydata...

resourceType readonly & string? - Referenced resource type

id readonly & string? - The logical [id] of a resource using a local reference (i.e. a relative reference)

url readonly & string? - Absolute URL - a reference to a resource by its absolute location

health.fhir.r4: RelatedArtifact

Closed record

Related artifacts for a knowledge resource.

Fields

Fields Included from *Element

id string
extension Extension[]
Element...

id string? - Unique id for inter-element referencing

extension Extension[]? - Additional content defined by implementations

'type code - documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of

label string? - Short label

display string? - Brief description of the related artifact

citation markdown? - Bibliographic citation for the artifact

url urlType? - Where the artifact can be accessed

document Attachment? - What document is being referenced

'resource canonical? - What resource is being referenced

health.fhir.r4: RelatedArtifactExtension

Closed record

Fields

url uri -

valueRelatedArtifact RelatedArtifact -

health.fhir.r4: RelatedPerson

FHIR RelatedPerson resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_RELATEDPERSON(default RESOURCE_NAME_RELATEDPERSON) - The type of the resource describes

meta BaseRelatedPersonMeta(default { profile : [PROFILE_BASE_RELATEDPERSON] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

identifier Identifier[]? - Identifier for a person within a particular scope.

extension Extension[]? - 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.

period Period? - The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.

address Address[]? - Address where the related person can be contacted or visited.

gender RelatedPersonGender? - Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

modifierExtension Extension[]? - 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).

active boolean? - Whether this related person record is in active use.

photo Attachment[]? - Image of the person.

language code? - The base language in which the resource is written.

birthDate date? - The date on which the related person was born.

contained Resource[]? - 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.

patient Reference - The patient this person is related to.

name HumanName[]? - A name associated with the person.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

telecom ContactPoint[]? - A contact detail for the person, e.g. a telephone number or an email address.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

communication RelatedPersonCommunication[]? - A language which may be used to communicate with about the patient's health.

relationship CodeableConcept[]? - The nature of the relationship between a patient and the related person.

never... - Rest field

health.fhir.r4: RelatedPersonCommunication

Closed record

FHIR RelatedPersonCommunication datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

language CodeableConcept - The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. 'en' for English, or 'en-US' for American English versus 'en-EN' for England English.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

preferred boolean? - Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

health.fhir.r4: RequestGroup

FHIR RequestGroup resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_REQUESTGROUP(default RESOURCE_NAME_REQUESTGROUP) - The type of the resource describes

meta BaseRequestGroupMeta(default { profile : [PROFILE_BASE_REQUESTGROUP] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

note Annotation[]? - Provides a mechanism to communicate additional information about the response.

extension Extension[]? - 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.

code CodeableConcept? - A code that identifies what the overall request group is.

subject Reference? - The subject for which the request group was created.

modifierExtension Extension[]? - 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).

reasonReference Reference[]? - Indicates another resource whose existence justifies this request group.

language code? - The base language in which the resource is written.

instantiatesUri uri[]? - A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.

action RequestGroupAction[]? - The actions, if any, produced by the evaluation of the artifact.

id string? - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

reasonCode CodeableConcept[]? - Describes the reason for the request group in coded or textual form.

text Narrative? - A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

basedOn Reference[]? - A plan, proposal or order that is fulfilled in whole or in part by this request.

identifier Identifier[]? - Allows a service to provide a unique, business identifier for the request.

authoredOn dateTime? - Indicates when the request group was created.

author Reference? - Provides a reference to the author of the request group.

replaces Reference[]? - Completed or terminated request(s) whose function is taken by this new request.

encounter Reference? - Describes the context of the request group, if any.

instantiatesCanonical canonical[]? - A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.

priority RequestGroupPriority? - Indicates how quickly the request should be addressed with respect to other requests.

intent RequestGroupIntent - Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.

contained Resource[]? - 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.

implicitRules uri? - A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

groupIdentifier Identifier? - A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.

status RequestGroupStatus - The current state of the request. For request groups, the status reflects the status of all the requests in the group.

never... - Rest field

health.fhir.r4: RequestGroupAction

Closed record

FHIR RequestGroupAction datatype record.

Fields

cardinalityBehavior RequestGroupActionCardinalityBehavior? - Defines whether the action can be selected multiple times.

extension Extension[]? - 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.

code CodeableConcept[]? - A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation template.

prefix string? - A user-visible prefix for the action.

modifierExtension Extension[]? - 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).

description string? - A short description of the action used to provide a summary to display to the user.

title string? - The title of the action displayed to a user.

'type CodeableConcept? - The type of action to perform (create, update, remove).

groupingBehavior RequestGroupActionGroupingBehavior? - Defines the grouping behavior for the action and its children.

participant Reference[]? - The participant that should perform or be responsible for this action.

timingAge Age? - An optional value describing when the action should be performed.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

relatedAction RequestGroupActionRelatedAction[]? - A relationship to another action such as 'before' or '30-60 minutes after start of'.

timingDuration Duration? - An optional value describing when the action should be performed.

textEquivalent string? - A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.

timingTiming Timing? - An optional value describing when the action should be performed.

'resource Reference? - The resource that is the target of the action (e.g. CommunicationRequest).

timingPeriod Period? - An optional value describing when the action should be performed.

documentation RelatedArtifact[]? - 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.

priority RequestGroupActionPriority? - Indicates how quickly the action should be addressed with respect to other actions.

requiredBehavior RequestGroupActionRequiredBehavior? - Defines expectations around whether an action is required.

condition RequestGroupActionCondition[]? - An expression that describes applicability criteria, or start/stop conditions for the action.

selectionBehavior RequestGroupActionSelectionBehavior? - Defines the selection behavior for the action and its children.

timingRange Range? - An optional value describing when the action should be performed.

precheckBehavior RequestGroupActionPrecheckBehavior? - Defines whether the action should usually be preselected.

timingDateTime dateTime? - An optional value describing when the action should be performed.

health.fhir.r4: RequestGroupActionCondition

Closed record

FHIR RequestGroupActionCondition datatype record.

Fields

extension Extension[]? - 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.

expression Expression? - An expression that returns true or false, indicating whether or not the condition is satisfied.

kind RequestGroupActionConditionKind - The kind of condition.

modifierExtension Extension[]? - 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).

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

health.fhir.r4: RequestGroupActionRelatedAction

Closed record

FHIR RequestGroupActionRelatedAction datatype record.

Fields

extension Extension[]? - 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.

modifierExtension Extension[]? - 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).

actionId id - The element id of the action this is related to.

offsetDuration Duration? - A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

offsetRange Range? - A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

id string? - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

relationship RequestGroupActionRelatedActionRelationship - The relationship of this action to the related action.

health.fhir.r4: RequestQueryParameter

Closed record

Represents incoming FHIR request search parameter

Fields

originalName string - Original incoming request query param name

name string - Name of the search parameter (FHIR)

modifier FHIRSearchParameterModifier|string? - Search parameter modifier

values string[] - Values of the query parameter

health.fhir.r4: RequestSearchParameter

Record type that holds original incoming values and processed information about the request search parameter.

Fields

namereadonly string - Name of the search parameter (Key of the query parameter)

valuereadonly string - Original incoming search parameter value in string format

'typereadonly FHIRSearchParameterType - Type of search parameter

typedValuereadonly FHIRTypedSearchParameter - Parsed/Decoded search parameter value based on the type of the search parameter

health.fhir.r4: ResearchDefinition

FHIR ResearchDefinition resource record.

Fields

Fields Included from *DomainResource

text Narrative
contained Resource[]
extension Extension[]
modifierExtension Extension[]
resourceType string
id string
meta Meta
implicitRules uri
language code
anydata...

resourceType RESOURCE_NAME_RESEARCHDEFINITION(default RESOURCE_NAME_RESEARCHDEFINITION) - The type of the resource describes

meta BaseResearchDefinitionMeta(default { profile : [PROFILE_BASE_RESEARCHDEFINITION] }) - The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

date dateTime? - The date (and optionally time) when the research definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the research definition changes.

copyright markdown? - A copyright statement relating to the research definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research definition.

extension Extension[]? - 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.

approvalDate date? - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

subjectCodeableConcept CodeableConcept?

functions

classes

constants

enums

variables

annotations

records

errors

objectTypes

unionTypes

intersectionTypes

stringTypes

integerTypes

ballerinax/health.fhir.r4 Ballerina library

FHIR R4 Base module

Sample Usage

Prerequisites

1. Parse JSON FHIR resource to FHIR resource model

2. Creating FHIR Resource models and serializing to JSON wire formats

Functions

annotationDataTypeValidationFunction

Parameters

Return Type

clientErrorToFhirError

Parameters

Return Type

compareResources

Parameters

complexDataTypeJsonSerializer

Parameters

Return Type

complexDataTypeXMLSerializer

Parameters

Return Type

createFhirBundle

Parameters

Return Type

createFHIRError

Parameters

Return Type

createInternalFHIRError

Parameters

Return Type

createParserErrorFrom

Parameters

Return Type

dataFilterDataTypeValidationFunction

Parameters

Return Type

dataRequirementDataTypeValidationFunction

Parameters

Return Type

decodeFhirSearchParameters

Parameters

dosageDataTypeValidationFunction

Parameters

Return Type

doseAndRateDataTypeValidationFunction

Parameters

Return Type

elementDefinitionDataTypeValidationFunction

Parameters

Return Type

errorToOperationOutcome

Parameters

Return Type

executeResourceJsonSerializer

Parameters

Return Type

executeResourceXMLSerializer

Parameters

Return Type

fhirBundleJsonSerializer

Parameters

fhirBundleXmlSerializer

Parameters

fhirResourceJsonSerializer

Parameters

Return Type

fhirResourceXMLSerializer