---
title: "Metadata data model"
url: "https://docs.unified.to/fhir/metadata/model"
description: "The Metadata data model object in Unified's Metadata API: 9 fields, including resourceType, status and date, with types and enum values."
date: "2026-11-20T18:13:18.192Z"
updated: "2026-11-20T18:13:18.192Z"
---
# Metadata data model

Updated: November 20, 2026

| Field                                               | Type                                   | Required | Description                                                                                                                                                                                     |                                          |
| --------------------------------------------------- | -------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- |
| resourceType                                        | enum                                   | Yes      | Always CapabilityStatement Values: Patient, Practitioner, Encounter, Observation, Condition, AllergyIntolerance, MedicationRequest, Immunization, Bundle, OperationOutcome, CapabilityStatement |                                          |
| status                                              | enum                                   | Yes      | active Values: active                                                                                                                                                                           |                                          |
| date                                                | string                                 | Yes      | Date last changed                                                                                                                                                                               |                                          |
| kind                                                | enum                                   | Yes      | instance Values: instance                                                                                                                                                                       |                                          |
| software                                            | object                                 | No       | Software that is covered by this capability statement                                                                                                                                           |                                          |
| software.name                                       | string                                 | Yes      | A name the software is known by                                                                                                                                                                 |                                          |
| implementation                                      | object                                 | No       | If this describes a specific instance                                                                                                                                                           |                                          |
| implementation.description                          | string                                 | Yes      | Describes this specific instance                                                                                                                                                                |                                          |
| implementation.url                                  | string                                 | No       | Base URL for the installation                                                                                                                                                                   |                                          |
| fhirVersion                                         | string                                 | Yes      | FHIR Version the system supports (4.0.1)                                                                                                                                                        |                                          |
| format                                              | string\[\]                             | No       | formats supported (json, application/fhir+json)                                                                                                                                                 |                                          |
| rest                                                | FhirCapabilityStatementRest\[\]        | No       | If the endpoint is a RESTful one                                                                                                                                                                |                                          |
| rest\[\].mode                                       | enum                                   | Yes      | server Values: server                                                                                                                                                                           |                                          |
| rest\[\].documentation                              | string                                 | No       | General description of implementation                                                                                                                                                           |                                          |
| rest\[\].security                                   | FhirCapabilityStatementRest\_security  | No       | Information about security of implementation                                                                                                                                                    |                                          |
| rest\[\].security.description                       | string                                 | No       | General description of how security works                                                                                                                                                       |                                          |
| rest\[\].resource                                   | FhirCapabilityStatementResource\[\]    | No       | Resource served on the REST interface                                                                                                                                                           |                                          |
| rest\[\].resource\[\].type                          | string                                 | Yes      | A resource type that is supported                                                                                                                                                               |                                          |
| rest\[\].resource\[\].interaction                   | FhirCapabilityStatementInteraction\[\] | No       | What operations are supported?                                                                                                                                                                  |                                          |
| rest\[\].resource\[\].interaction\[\].code          | enum                                   | Yes      | read \| search-type Values: read, search-type                                                                                                                                                   |                                          |
| rest\[\].resource\[\].searchParam                   | FhirCapabilityStatementSearchParam\[\] | No       | Search parameters supported by implementation                                                                                                                                                   |                                          |
| rest\[\].resource\[\].searchParam\[\].name          | string                                 | Yes      | Name of search parameter                                                                                                                                                                        |                                          |
| rest\[\].resource\[\].searchParam\[\].type          | enum                                   | Yes      | token \| date                                                                                                                                                                                   | reference Values: token, date, reference |
| rest\[\].resource\[\].searchParam\[\].documentation | string                                 | No       | Server-specific usage                                                                                                                                                                           |                                          |

## TypeScript

```typescript
export type FhirCapabilityStatement = {
	resourceType: 'Patient' | 'Practitioner' | 'Encounter' | 'Observation' | 'Condition' | 'AllergyIntolerance' | 'MedicationRequest' | 'Immunization' | 'Bundle' | 'OperationOutcome' | 'CapabilityStatement'; // Always CapabilityStatement
	status: 'active'; // active
	date: string; // Date last changed
	kind: 'instance'; // instance
	software?: {
		name: string; // A name the software is known by 
	}; // Software that is covered by this capability statement
	implementation?: {
		description: string; // Describes this specific instance 
		url?: string; // Base URL for the installation 
	}; // If this describes a specific instance
	fhirVersion: string; // FHIR Version the system supports (4.0.1)
	format?: string[]; // formats supported (json, application/fhir+json)
	rest?: []; // If the endpoint is a RESTful one
} 
```

## Zod

```typescript
import { z } from 'zod';

export const ZodFhirCapabilityStatement = z.object({
	resourceType: z.enum("Patient", "Practitioner", "Encounter", "Observation", "Condition", "AllergyIntolerance", "MedicationRequest", "Immunization", "Bundle", "OperationOutcome", "CapabilityStatement").describe("Always CapabilityStatement"),
	status: z.enum("active").describe("active"),
	date: z.string().describe("Date last changed"),
	kind: z.enum("instance").describe("instance"),
	software: z.object({
			name: z.string().describe("A name the software is known by")
}).optional().describe("Software that is covered by this capability statement"),
	implementation: z.object({
			description: z.string().describe("Describes this specific instance"),
			url: z.string().optional().describe("Base URL for the installation")
}).optional().describe("If this describes a specific instance"),
	fhirVersion: z.string().describe("FHIR Version the system supports (4.0.1)"),
	format: z.array().optional().describe("formats supported (json, application/fhir+json)"),
	rest: z.array().optional().describe("If the endpoint is a RESTful one")
});
```

## Python

```python
import dataclasses

@dataclasses.dataclass
class FhirCapabilityStatementResourcetype(str, Enum):
	Patient = 'Patient'
	Practitioner = 'Practitioner'
	Encounter = 'Encounter'
	Observation = 'Observation'
	Condition = 'Condition'
	AllergyIntolerance = 'AllergyIntolerance'
	MedicationRequest = 'MedicationRequest'
	Immunization = 'Immunization'
	Bundle = 'Bundle'
	OperationOutcome = 'OperationOutcome'
	CapabilityStatement = 'CapabilityStatement'

@dataclasses.dataclass
class FhirCapabilityStatementStatus(str, Enum):
	active = 'active'

@dataclasses.dataclass
class FhirCapabilityStatementKind(str, Enum):
	instance = 'instance'

@dataclasses.dataclass
class PropertyFhirCapabilityStatementSoftware:
	"""A name the software is known by"""
	name: Optional[str]

@dataclasses.dataclass
class PropertyFhirCapabilityStatementImplementation:
	"""Describes this specific instance"""
	description: Optional[str]
	"""Base URL for the installation"""
	url: Optional[str]

@dataclasses.dataclass
class FhirCapabilityStatement:
	"""Always CapabilityStatement"""
	resourceType: FhirCapabilityStatementResourcetype
	"""active"""
	status: FhirCapabilityStatementStatus
	"""Date last changed"""
	date: str
	"""instance"""
	kind: FhirCapabilityStatementKind
	"""Software that is covered by this capability statement"""
	software: Optional[PropertyFhirCapabilityStatementSoftware]
	"""If this describes a specific instance"""
	implementation: Optional[PropertyFhirCapabilityStatementImplementation]
	"""FHIR Version the system supports (4.0.1)"""
	fhirVersion: str
	"""formats supported (json, application/fhir+json)"""
	format: Optional[List[List[str]]]
	"""If the endpoint is a RESTful one"""
	rest: Optional[PropertyFhirCapabilityStatementRest]
```
