IE (Ireland) Core Implementation Guide
0.3.0 - draft Ireland flag

IE (Ireland) Core Implementation Guide - Local Development build (v0.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

CapabilityStatement: IE Core Server CapabilityStatement

Official URL: https://hl7-ie.github.io/ie-core/fhir/ie/core/CapabilityStatement/ie-core-server Version: 0.3.0
Draft as of 2025-01-01 Computable Name: IECoreServerCapabilityStatement

This CapabilityStatement describes the expected capabilities of a system that conforms to the IE Core Implementation Guide as a Server. It lists the RESTful interactions, supported profiles, and search parameters for each resource type.

Raw OpenAPI-Swagger Definition file | Download

IE Core Server CapabilityStatement

  • Implementation Guide Version: 0.3.0
  • FHIR Version: 4.0.1
  • Supported Formats: json, xml
  • Published on: 2025-01-01
  • Published by: Nithin Mohan T K (Proof of Concept)

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: server

The IE Core Server SHALL support the Patient resource and SHOULD support all other resources listed in this CapabilityStatement. The server SHALL implement REST behaviour according to the FHIR specification.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
PatientSupported Profiles
  IE Core Patientversion: 0.3.0)
  IE Core Patient (Patient Summary)version: 0.3.0)
yyyyname, family, given, gender, birthdate, identifier, _id
PractitionerSupported Profiles
  IE Core Practitionerversion: 0.3.0)
yyyyname, identifier
PractitionerRoleSupported Profiles
  IE Core PractitionerRoleversion: 0.3.0)
yyyypractitioner, organization, specialty
OrganizationSupported Profiles
  IE Core Organizationversion: 0.3.0)
yyyyname, identifier, address
LocationSupported Profiles
  IE Core Locationversion: 0.3.0)
yyyyname, address
EncounterSupported Profiles
  IE Core Encounterversion: 0.3.0)
yyyypatient, date, type, status, class
ConditionSupported Profiles
  IE Core Condition Encounter Diagnosisversion: 0.3.0)
  IE Core Condition Problems and Health Concernsversion: 0.3.0)
yyyypatient, code, onset-date, clinical-status, category
ProcedureSupported Profiles
  IE Core Procedureversion: 0.3.0)
yyyypatient, date, code, status
ObservationSupported Profiles
  IE Core Observation Clinical Resultversion: 0.3.0)
  IE Core Laboratory Result Observationversion: 0.3.0)
  IE Core Simple Observationversion: 0.3.0)
  IE Core Vital Signsversion: 0.3.0)
  IE Core Blood Pressureversion: 0.3.0)
yyyypatient, category, code, date, status
DiagnosticReportSupported Profiles
  IE Core DiagnosticReport for Laboratory Resultsversion: 0.3.0)
  IE Core DiagnosticReport for Report and Note Exchangeversion: 0.3.0)
yyyypatient, category, code, date, status
DocumentReferenceSupported Profiles
  IE Core DocumentReferenceversion: 0.3.0)
yyyypatient, type, category, date
MedicationSupported Profiles
  IE Core Medicationversion: 0.3.0)
yyyycode
ImmunizationSupported Profiles
  IE Core Immunizationversion: 0.3.0)
yyyypatient, date, status
AllergyIntoleranceSupported Profiles
  IE Core AllergyIntoleranceversion: 0.3.0)
yyyypatient, clinical-status
CarePlanSupported Profiles
  IE Core CarePlanversion: 0.3.0)
yyyypatient, category, status, date
CareTeamSupported Profiles
  IE Core CareTeamversion: 0.3.0)
yyyypatient, status
GoalSupported Profiles
  IE Core Goalversion: 0.3.0)
yyyypatient, lifecycle-status
ServiceRequestSupported Profiles
  IE Core ServiceRequestversion: 0.3.0)
yyyypatient, status, category
CoverageSupported Profiles
  IE Core Coverageversion: 0.3.0)
yyyypatient, status
DeviceSupported Profiles
  IE Core Implantable Deviceversion: 0.3.0)
yyyypatient, type
ProvenanceSupported Profiles
  IE Core Provenanceversion: 0.3.0)
yyyytarget, patient
RelatedPersonSupported Profiles
  IE Core RelatedPersonversion: 0.3.0)
yyyypatient
QuestionnaireResponseSupported Profiles
  IE Core QuestionnaireResponseversion: 0.3.0)
yyyypatient, questionnaire, status
SpecimenSupported Profiles
  IE Core Specimenversion: 0.3.0)
yyyypatient, type

Core FHIR Resource
Patient
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLnamestring
SHALLfamilystring
SHALLgivenstring
SHALLgendertoken
SHALLbirthdatedate
SHALLidentifiertoken
SHALL_idtoken
 
Core FHIR Resource
Practitioner
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLnamestring
SHALLidentifiertoken
 
Core FHIR Resource
PractitionerRole
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpractitionerreference
SHALLorganizationreference
SHALLspecialtytoken
 
Core FHIR Resource
Organization
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLnamestring
SHALLidentifiertoken
SHALLaddressstring
 
Core FHIR Resource
Location
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLnamestring
SHALLaddressstring
 
Core FHIR Resource
Encounter
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLdatedate
SHALLtypetoken
SHALLstatustoken
SHALLclasstoken
 
Core FHIR Resource
Condition
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLcodetoken
SHALLonset-datedate
SHALLclinical-statustoken
SHALLcategorytoken
 
Core FHIR Resource
Procedure
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLdatedate
SHALLcodetoken
SHALLstatustoken
 
Core FHIR Resource
Observation
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLcategorytoken
SHALLcodetoken
SHALLdatedate
SHALLstatustoken
 
Core FHIR Resource
DiagnosticReport
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLcategorytoken
SHALLcodetoken
SHALLdatedate
SHALLstatustoken
 
Core FHIR Resource
DocumentReference
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLtypetoken
SHALLcategorytoken
SHALLdatedate
 
Core FHIR Resource
Medication
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLcodetoken
 
Core FHIR Resource
Immunization
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLdatedate
SHALLstatustoken
 
Core FHIR Resource
AllergyIntolerance
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLclinical-statustoken
 
Core FHIR Resource
CarePlan
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLcategorytoken
SHALLstatustoken
SHALLdatedate
 
Core FHIR Resource
CareTeam
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLstatustoken
 
Core FHIR Resource
Goal
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Supported Profiles

IE Core Goalversion: 0.3.0)

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLlifecycle-statustoken
 
Core FHIR Resource
ServiceRequest
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLstatustoken
SHALLcategorytoken
 
Core FHIR Resource
Coverage
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLstatustoken
 
Core FHIR Resource
Device
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLtypetoken
 
Core FHIR Resource
Provenance
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLtargetreference
SHALLpatientreference
 
Core FHIR Resource
RelatedPerson
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
 
Core FHIR Resource
QuestionnaireResponse
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLquestionnairereference
SHALLstatustoken
 
Core FHIR Resource
Specimen
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLtypetoken