eHealth Infrastructure
3.3.0 - ci-build Denmark flag

eHealth Infrastructure, published by Den telemedicinske infrastruktur (eHealth Infrastructure). This guide is not an authorized publication; it is the continuous build for version 3.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/fut-infrastructure/implementation-guide/ and changes regularly. See the Directory of published versions

CapabilityStatement: patient

Official URL: http://ehealth.sundhed.dk/fhir/CapabilityStatement/patient Version: 3.3.0
Active as of 2021-08-20 Computable Name: patient

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement patient

  • Implementation Guide Version: 3.3.0
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, xml, application/fhir+json, json, application/x-turtle, ttl, html/json, html/xml, html/turtle
  • Supported Patch Formats: application/json-patch+json
  • Published on: 2021-08-20 13:16:14+0200
  • Published by: Den telemedicinske infrastruktur (eHealth Infrastructure)

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

Security
Enable CORS: no
Security services supported:
Summary of System-wide Interactions

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 TypeProfileRV-RSUPCDH-IH-TSearches_include_revincludeOperations
Appointmenthttp://hl7.org/fhir/StructureDefinition/Appointment
Additional supported profiles:
  ehealth-appointment
  ehealth-group-appointment
  ehealth-group-videoappointment
  ehealth-videoappointment
yyyyyy_language, date, specialty, service-category, _lastUpdated, slot, reason-code, based-on, appointmentGroupId, patient, responsible, supporting-info, careteamParticipant, identifier, practitioner, appointment-type, part-status, service-type, _security, _filter, actor, _profile, intended-audience, _has, _tag, reason-reference, location, _id, _content, _text, status*, Appointment:actor, Appointment:patientAppointment:careteamParticipant, Appointment:intended-audience, Appointment:responsible, Appointment:supporting-info, Communication:based-on, Communication:careTeamRecipient, Communication:careTeamSender, Communication:on-behalf-of, Communication:part-of$exportAsiCal, $meta, $meta-add, $meta-delete, $validate
CodeSystemhttp://hl7.org/fhir/StructureDefinition/CodeSystemyyy_language, date, code, context-type-value, jurisdiction, _lastUpdated, description, context-type, language, title, context-quantity, context, context-type-quantity, identifier, content-mode, _security, version, url, _filter, supplements, system, _profile, _has, _tag, name, publisher, _source, _id, _content, _text, status*Appointment:careteamParticipant, Appointment:intended-audience, Appointment:responsible, Appointment:supporting-info, CodeSystem:supplements, Communication:based-on, Communication:careTeamRecipient, Communication:careTeamSender, Communication:on-behalf-of, Communication:part-of$lookup, $subsumes, $validate
Communicationhttp://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-message
Additional supported profiles:
  ehealth-communication
  ehealth-message
yyyyyy_language, administrativeStatus, subject, _lastUpdated, part-of, medium, on-behalf-of, threadId, based-on, patient, instantiates-uri, identifier, period, _security, instantiates-canonical, communicationCategory, received, encounter, communicationGroupId, careTeamRecipient, sent, _filter, careTeamSender, communicationParticipant, communicationRelatesTo, _profile, sender, _has, _tag, recipient, _id, category, restrictionCategory, _content, _text, status*, Communication:based-on, Communication:careTeamRecipient, Communication:careTeamSender, Communication:encounter, Communication:instantiates-canonical, Communication:on-behalf-of, Communication:part-of, Communication:patient, Communication:recipient, Communication:sender, Communication:subjectAppointment:careteamParticipant, Appointment:intended-audience, Appointment:responsible, Appointment:supporting-info, Communication:based-on, Communication:careTeamRecipient, Communication:careTeamSender, Communication:on-behalf-of, Communication:part-of$validate
OperationDefinitionhttp://hl7.org/fhir/StructureDefinition/OperationDefinitiony_language, date, code, instance, context-type-value, jurisdiction, description, context-type, title, type, context-quantity, output-profile, context, context-type-quantity, kind, version, url, input-profile, system, name, publisher, _id, base, status*, OperationDefinition:base, OperationDefinition:input-profile, OperationDefinition:output-profileAppointment:careteamParticipant, Appointment:intended-audience, Appointment:responsible, Appointment:supporting-info, Communication:based-on, Communication:careTeamRecipient, Communication:careTeamSender, Communication:instantiates-canonical, Communication:on-behalf-of, Communication:part-of, OperationDefinition:base
Patienthttp://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-patient
Additional supported profiles:
  ehealth-patient
  http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-skrsPatient
yyyy_language, birthdate, deceased, address-state, gender, link, language, address-country, death-date, phonetic, telecom, address-city, email, given, identifier, address, general-practitioner, _security, active, address-postalcode, phone, organization, address-use, name, _id, family*, Patient:linkAppointment:actor, Appointment:careteamParticipant, Appointment:intended-audience, Appointment:patient, Appointment:responsible, Appointment:supporting-info, Communication:based-on, Communication:careTeamRecipient, Communication:careTeamSender, Communication:on-behalf-of, Communication:part-of, Communication:patient, Communication:recipient, Communication:sender, Communication:subject, Patient:link, Person:link, Person:patient, RelatedPerson:patient$createPatient, $updatePatientWithSKRSData, $validate
Personhttp://hl7.org/fhir/StructureDefinition/Person_language, identifier, address, birthdate, address-state, gender, practitioner, link, relatedperson, address-postalcode, address-country, phonetic, phone, patient, organization, address-use, name, telecom, _id, address-city, email*, Person:link, Person:organization, Person:patient, Person:practitioner, Person:relatedpersonAppointment:careteamParticipant, Appointment:intended-audience, Appointment:responsible, Appointment:supporting-info, Communication:based-on, Communication:careTeamRecipient, Communication:careTeamSender, Communication:on-behalf-of, Communication:part-of, Person:link$match
RelatedPersonhttp://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-relatedperson
Additional supported profiles:
  ehealth-relatedperson
yyyyyyy_language, birthdate, address-state, gender, _lastUpdated, address-country, phonetic, patient, telecom, address-city, relationship, email, identifier, address, _security, active, address-postalcode, _profile, phone, _has, _tag, address-use, name, _id, _content, _text*, RelatedPerson:patientAppointment:actor, Appointment:careteamParticipant, Appointment:intended-audience, Appointment:responsible, Appointment:supporting-info, Communication:based-on, Communication:careTeamRecipient, Communication:careTeamSender, Communication:on-behalf-of, Communication:part-of, Communication:recipient, Communication:sender, Patient:link, Person:link, Person:relatedperson$validate
SearchParameterhttp://hl7.org/fhir/StructureDefinition/SearchParameteryyyyyyyyy_language, date, code, context-type-value, jurisdiction, _lastUpdated, derived-from, description, context-type, type, context-quantity, context, context-type-quantity, _security, sp-unique-url, version, url, target, _filter, component, _profile, _has, _tag, name, publisher, _source, _id, _content, _text, base, status*, SearchParameter:componentAppointment:careteamParticipant, Appointment:intended-audience, Appointment:responsible, Appointment:supporting-info, Communication:based-on, Communication:careTeamRecipient, Communication:careTeamSender, Communication:on-behalf-of, Communication:part-of, SearchParameter:component, SearchParameter:derived-from$expunge, $meta, $meta-add, $meta-delete, $validate
StructureDefinitionhttp://hl7.org/fhir/StructureDefinition/StructureDefinition
Additional supported profiles:
  ehealth-definedquestion
yyyy_language, date, context-type-value, jurisdiction, _lastUpdated, description, context-type, experimental, title, type, context-quantity, path, base-path, context, sd-unique-url, keyword, context-type-quantity, identifier, valueset, kind, _security, abstract, version, url, _filter, _profile, ext-context, _has, _tag, name, publisher, derivation, _source, _id, _content, _text, base, status*, StructureDefinition:valuesetAppointment:careteamParticipant, Appointment:intended-audience, Appointment:responsible, Appointment:supporting-info, Communication:based-on, Communication:careTeamRecipient, Communication:careTeamSender, Communication:on-behalf-of, Communication:part-of, OperationDefinition:input-profile, OperationDefinition:output-profile, StructureDefinition:base$generateSnapshot, $snapshot, $validate
ValueSethttp://hl7.org/fhir/StructureDefinition/ValueSetyyy_language, date, code, context-type-value, jurisdiction, _lastUpdated, description, context-type, title, reference, context-quantity, context, context-type-quantity, identifier, _security, version, url, expansion, _filter, _profile, _has, _tag, name, publisher, _source, _id, _content, _text, status*Appointment:careteamParticipant, Appointment:intended-audience, Appointment:responsible, Appointment:supporting-info, Communication:based-on, Communication:careTeamRecipient, Communication:careTeamSender, Communication:on-behalf-of, Communication:part-of, StructureDefinition:valueset$expand, $validate-code, $validate

Resource Conformance: supported Appointment

Base System Profile
Appointment
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports create, patch, search-type, update, vread, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_languagestring

The language of the resource

SHALLdatedate

Appointment date/time.

SHALLspecialtytoken

The specialty of a practitioner that would be required to perform the service requested in this appointment

SHALLservice-categorytoken

A broad categorization of the service that is to be performed during this appointment

SHALL_lastUpdateddate

Only return resources which were last updated as specified by the given range

SHALLslotreference

The slots that this appointment is filling

SHALLreason-codetoken

Coded reason this appointment is scheduled

SHALLbased-onreference

The service request this appointment is allocated to assess

SHALLappointmentGroupIdstring

Search parameter for finding resources based on group id

SHALLpatientreference

One of the individuals of the appointment is this patient

SHALLresponsiblereference

Search parameter for finding responsible entity on Appointment

SHALLsupporting-inforeference

Additional information to support the appointment

SHALLcareteamParticipantreference

Search parameter for finding appointments based on careteam participants

SHALLidentifiertoken

An Identifier of the Appointment

SHALLpractitionerreference

One of the individuals of the appointment is this practitioner

SHALLappointment-typetoken

The style of appointment or patient that has been booked in the slot (not service type)

SHALLpart-statustoken

The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests.

SHALLservice-typetoken

The specific service that is to be performed during this appointment

SHALL_securitytoken

Search for resources which have the given security labels

SHALL_filterstring

Search the contents of the resource's data using a filter

SHALLactorreference

Any one of the individuals participating in the appointment

SHALL_profileuri

Search for resources which have the given profile

SHALLintended-audiencereference

Search parameter for finding intended audience on Appointment

SHALL_hasstring

Return resources linked to by the given target

SHALL_tagtoken

Search for resources which have the given tag

SHALLreason-referencereference

Reason the appointment is to take place (resource)

SHALLlocationreference

This location is listed in the participants of the appointment

SHALL_idtoken

The ID of the resource

SHALL_contentstring

Search the contents of the resource's data using a fulltext search

SHALL_textstring

Search the contents of the resource's narrative using a fulltext search

SHALLstatustoken

The overall status of the appointment

 
Extended Operations
ConformanceOperationDocumentation
SHALL$exportAsiCal
SHALL$meta
SHALL$meta-add
SHALL$meta-delete
SHALL$validate

Resource Conformance: supported CodeSystem

Base System Profile
CodeSystem
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, vread, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_languagestring

The language of the resource

SHALLdatedate

The code system publication date

SHALLcodetoken

A code defined in the code system

SHALLcontext-type-valuecomposite

A use context type and value assigned to the code system

SHALLjurisdictiontoken

Intended jurisdiction for the code system

SHALL_lastUpdateddate

Only return resources which were last updated as specified by the given range

SHALLdescriptionstring

The description of the code system

SHALLcontext-typetoken

A type of use context assigned to the code system

SHALLlanguagetoken

A language in which a designation is provided

SHALLtitlestring

The human-friendly name of the code system

SHALLcontext-quantityquantity

A quantity- or range-valued use context assigned to the code system

SHALLcontexttoken

A use context assigned to the code system

SHALLcontext-type-quantitycomposite

A use context type and quantity- or range-based value assigned to the code system

SHALLidentifiertoken

External identifier for the code system

SHALLcontent-modetoken

not-present | example | fragment | complete | supplement

SHALL_securitytoken

Search for resources which have the given security labels

SHALLversiontoken

The business version of the code system

SHALLurluri

The uri that identifies the code system

SHALL_filterstring

Search the contents of the resource's data using a filter

SHALLsupplementsreference

Find code system supplements for the referenced code system

SHALLsystemuri

The system for any codes defined by this code system (same as 'url')

SHALL_profileuri

Search for resources which have the given profile

SHALL_hasstring

Return resources linked to by the given target

SHALL_tagtoken

Search for resources which have the given tag

SHALLnamestring

Computationally friendly name of the code system

SHALLpublisherstring

Name of the publisher of the code system

SHALL_sourceuri

Search for resources which have the given source value (Resource.meta.source)

SHALL_idtoken

The ID of the resource

SHALL_contentstring

Search the contents of the resource's data using a fulltext search

SHALL_textstring

Search the contents of the resource's narrative using a fulltext search

SHALLstatustoken

The current status of the code system

 
Extended Operations
ConformanceOperationDocumentation
SHALL$lookup
SHALL$subsumes
SHALL$validate

Resource Conformance: supported Communication

Base System Profile
ehealth-message
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports create, patch, search-type, delete, vread, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_languagestring

The language of the resource

SHALLadministrativeStatustoken

Search parameter for finding communication based on administrative status

SHALLsubjectreference

Focus of message

SHALL_lastUpdateddate

Only return resources which were last updated as specified by the given range

SHALLpart-ofreference

Part of this action

SHALLmediumtoken

A channel of communication

SHALLon-behalf-ofreference

Search parameter for finding communication based on on-behalf-of

SHALLthreadIdstring

Search parameter for finding communication based on thread id

SHALLbased-onreference

Request fulfilled by this communication

SHALLpatientreference

Focus of message

SHALLinstantiates-uriuri

Instantiates external protocol or definition

SHALLidentifiertoken

Unique identifier

SHALLperioddate

Search parameter for finding communication based on period

SHALL_securitytoken

Search for resources which have the given security labels

SHALLinstantiates-canonicalreference

Instantiates FHIR protocol or definition

SHALLcommunicationCategorytoken

Search parameter for finding communication based on the category code

SHALLreceiveddate

When received

SHALLencounterreference

Encounter created as part of

SHALLcommunicationGroupIdstring

Search parameter for finding resources based on group id

SHALLcareTeamRecipientreference

Search parameter for finding communication based on CareTeam recipient

SHALLsentdate

When sent

SHALL_filterstring

Search the contents of the resource's data using a filter

SHALLcareTeamSenderreference

Search parameter for finding communication based on CareTeam sender

SHALLcommunicationParticipantreference

Search parameter for finding communication based on participant

SHALLcommunicationRelatesToreference

Search parameter for finding communication based on either participant or episode of care.

SHALL_profileuri

Search for resources which have the given profile

SHALLsenderreference

Message sender

SHALL_hasstring

Return resources linked to by the given target

SHALL_tagtoken

Search for resources which have the given tag

SHALLrecipientreference

Message recipient

SHALL_idtoken

The ID of the resource

SHALLcategorytoken

Message category

SHALLrestrictionCategorytoken

Search parameter for finding communication based on CareTeam recipient

SHALL_contentstring

Search the contents of the resource's data using a fulltext search

SHALL_textstring

Search the contents of the resource's narrative using a fulltext search

SHALLstatustoken

preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate

Resource Conformance: supported OperationDefinition

Base System Profile
OperationDefinition
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_languagestring

The language of the resource

SHALLdatedate

The operation definition publication date

SHALLcodetoken

Name used to invoke the operation

SHALLinstancetoken

Invoke on an instance?

SHALLcontext-type-valuecomposite

A use context type and value assigned to the operation definition

SHALLjurisdictiontoken

Intended jurisdiction for the operation definition

SHALLdescriptionstring

The description of the operation definition

SHALLcontext-typetoken

A type of use context assigned to the operation definition

SHALLtitlestring

The human-friendly name of the operation definition

SHALLtypetoken

Invoke at the type level?

SHALLcontext-quantityquantity

A quantity- or range-valued use context assigned to the operation definition

SHALLoutput-profilereference

Validation information for out parameters

SHALLcontexttoken

A use context assigned to the operation definition

SHALLcontext-type-quantitycomposite

A use context type and quantity- or range-based value assigned to the operation definition

SHALLkindtoken

operation | query

SHALLversiontoken

The business version of the operation definition

SHALLurluri

The uri that identifies the operation definition

SHALLinput-profilereference

Validation information for in parameters

SHALLsystemtoken

Invoke at the system level?

SHALLnamestring

Computationally friendly name of the operation definition

SHALLpublisherstring

Name of the publisher of the operation definition

SHALL_idtoken

The ID of the resource

SHALLbasereference

Marks this as a profile of the base

SHALLstatustoken

The current status of the operation definition

 

Resource Conformance: supported Patient

Base System Profile
ehealth-patient
Profile Conformance
SHALL
Reference Policy

Supported Profiles

ehealth-patient
http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-skrsPatient

Interaction summary
  • Supports patch, search-type, vread, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_languagestring

The language of the resource

SHALLbirthdatedate

The patient's date of birth

SHALLdeceasedtoken

This patient has been marked as deceased, or as a death date entered

SHALLaddress-statestring

A state specified in an address

SHALLgendertoken

Gender of the patient

SHALLlinkreference

All patients linked to the given patient

SHALLlanguagetoken

Language code (irrespective of use value)

SHALLaddress-countrystring

A country specified in an address

SHALLdeath-datedate

The date of death has been provided and satisfies this search value

SHALLphoneticstring

A portion of either family or given name using some kind of phonetic matching algorithm

SHALLtelecomtoken

The value in any kind of telecom details of the patient

SHALLaddress-citystring

A city specified in an address

SHALLemailtoken

A value in an email contact

SHALLgivenstring

A portion of the given name of the patient

SHALLidentifiertoken

A patient identifier

SHALLaddressstring

A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text

SHALLgeneral-practitionerreference

Patient's nominated general practitioner, not the organization that manages the record

SHALL_securitytoken

The Security Label of the resource

SHALLactivetoken

Whether the patient record is active

SHALLaddress-postalcodestring

A postalCode specified in an address

SHALLphonetoken

A value in a phone contact

SHALLorganizationreference

The organization that is the custodian of the patient record

SHALLaddress-usetoken

A use code specified in an address

SHALLnamestring

A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text

SHALL_idtoken

The ID of the resource

SHALLfamilystring

A portion of the family name of the patient

 
Extended Operations
ConformanceOperationDocumentation
SHALL$createPatient
SHALL$updatePatientWithSKRSData
SHALL$validate

Resource Conformance: supported Person

Base System Profile
Person
Profile Conformance
SHALL
Reference Policy

Interaction summary

    Search Parameters
    ConformanceParameterTypeDocumentation
    SHALL_languagestring

    The language of the resource

    SHALLidentifiertoken

    A person Identifier

    SHALLaddressstring

    A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text

    SHALLbirthdatedate

    The person's date of birth

    SHALLaddress-statestring

    A state specified in an address

    SHALLgendertoken

    The gender of the person

    SHALLpractitionerreference

    The Person links to this Practitioner

    SHALLlinkreference

    Any link has this Patient, Person, RelatedPerson or Practitioner reference

    SHALLrelatedpersonreference

    The Person links to this RelatedPerson

    SHALLaddress-postalcodestring

    A postal code specified in an address

    SHALLaddress-countrystring

    A country specified in an address

    SHALLphoneticstring

    A portion of name using some kind of phonetic matching algorithm

    SHALLphonetoken

    A value in a phone contact

    SHALLpatientreference

    The Person links to this Patient

    SHALLorganizationreference

    The organization at which this person record is being managed

    SHALLaddress-usetoken

    A use code specified in an address

    SHALLnamestring

    A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text

    SHALLtelecomtoken

    The value in any kind of contact

    SHALL_idtoken

    The ID of the resource

    SHALLaddress-citystring

    A city specified in an address

    SHALLemailtoken

    A value in an email contact

     
    Extended Operations
    ConformanceOperationDocumentation
    SHALL$match

    Resource Conformance: supported RelatedPerson

    Base System Profile
    ehealth-relatedperson
    Profile Conformance
    SHALL
    Reference Policy

    Supported Profiles

    ehealth-relatedperson

    Interaction summary
    • Supports search-type, create, update, patch, delete, vread, read.

    Search Parameters
    ConformanceParameterTypeDocumentation
    SHALL_languagestring

    The language of the resource

    SHALLbirthdatedate

    The Related Person's date of birth

    SHALLaddress-statestring

    A state specified in an address

    SHALLgendertoken

    Gender of the related person

    SHALL_lastUpdateddate

    Only return resources which were last updated as specified by the given range

    SHALLaddress-countrystring

    A country specified in an address

    SHALLphoneticstring

    A portion of name using some kind of phonetic matching algorithm

    SHALLpatientreference

    The patient this related person is related to

    SHALLtelecomtoken

    The value in any kind of contact

    SHALLaddress-citystring

    A city specified in an address

    SHALLrelationshiptoken

    The relationship between the patient and the relatedperson

    SHALLemailtoken

    A value in an email contact

    SHALLidentifiertoken

    An Identifier of the RelatedPerson

    SHALLaddressstring

    A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text

    SHALL_securitytoken

    Search for resources which have the given security labels

    SHALLactivetoken

    Indicates if the related person record is active

    SHALLaddress-postalcodestring

    A postal code specified in an address

    SHALL_profileuri

    Search for resources which have the given profile

    SHALLphonetoken

    A value in a phone contact

    SHALL_hasstring

    Return resources linked to by the given target

    SHALL_tagtoken

    Search for resources which have the given tag

    SHALLaddress-usetoken

    A use code specified in an address

    SHALLnamestring

    A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text

    SHALL_idtoken

    The ID of the resource

    SHALL_contentstring

    Search the contents of the resource's data using a fulltext search

    SHALL_textstring

    Search the contents of the resource's narrative using a fulltext search

     
    Extended Operations
    ConformanceOperationDocumentation
    SHALL$validate

    Resource Conformance: supported SearchParameter

    Base System Profile
    SearchParameter
    Profile Conformance
    SHALL
    Reference Policy

    Interaction summary
    • Supports search-type, create, delete, history-instance, history-type, patch, vread, read, update.

    Search Parameters
    ConformanceParameterTypeDocumentation
    SHALL_languagestring

    The language of the resource

    SHALLdatedate

    The search parameter publication date

    SHALLcodetoken

    Code used in URL

    SHALLcontext-type-valuecomposite

    A use context type and value assigned to the search parameter

    SHALLjurisdictiontoken

    Intended jurisdiction for the search parameter

    SHALL_lastUpdateddate

    Only return resources which were last updated as specified by the given range

    SHALLderived-fromreference

    Original definition for the search parameter

    SHALLdescriptionstring

    The description of the search parameter

    SHALLcontext-typetoken

    A type of use context assigned to the search parameter

    SHALLtypetoken

    number | date | string | token | reference | composite | quantity | uri | special

    SHALLcontext-quantityquantity

    A quantity- or range-valued use context assigned to the search parameter

    SHALLcontexttoken

    A use context assigned to the search parameter

    SHALLcontext-type-quantitycomposite

    A use context type and quantity- or range-based value assigned to the search parameter

    SHALL_securitytoken

    Search for resources which have the given security labels

    SHALLsp-unique-urlcomposite

    Search parameter for making a SearchParameter unique by URL

    SHALLversiontoken

    The business version of the search parameter

    SHALLurluri

    Search parameter for finding a searchparameter by URL

    SHALLtargettoken

    Types of resource (if a resource reference)

    SHALL_filterstring

    Search the contents of the resource's data using a filter

    SHALLcomponentreference

    Defines how the part works

    SHALL_profileuri

    Search for resources which have the given profile

    SHALL_hasstring

    Return resources linked to by the given target

    SHALL_tagtoken

    Search for resources which have the given tag

    SHALLnamestring

    Computationally friendly name of the search parameter

    SHALLpublisherstring

    Name of the publisher of the search parameter

    SHALL_sourceuri

    Search for resources which have the given source value (Resource.meta.source)

    SHALL_idtoken

    The ID of the resource

    SHALL_contentstring

    Search the contents of the resource's data using a fulltext search

    SHALL_textstring

    Search the contents of the resource's narrative using a fulltext search

    SHALLbasetoken

    The resource type(s) this search parameter applies to

    SHALLstatustoken

    The current status of the search parameter

     
    Extended Operations
    ConformanceOperationDocumentation
    SHALL$expunge
    SHALL$meta

    Request a global list of tags, profiles, and security labels

    SHALL$meta-add

    Add tags, profiles, and/or security labels to a resource

    SHALL$meta-delete

    Delete tags, profiles, and/or security labels from a resource

    SHALL$validate

    Resource Conformance: supported StructureDefinition

    Base System Profile
    StructureDefinition
    Profile Conformance
    SHALL
    Reference Policy

    Supported Profiles

    ehealth-definedquestion

    Interaction summary
    • Supports create, search-type, vread, read.

    Search Parameters
    ConformanceParameterTypeDocumentation
    SHALL_languagestring

    The language of the resource

    SHALLdatedate

    The structure definition publication date

    SHALLcontext-type-valuecomposite

    A use context type and value assigned to the structure definition

    SHALLjurisdictiontoken

    Intended jurisdiction for the structure definition

    SHALL_lastUpdateddate

    Only return resources which were last updated as specified by the given range

    SHALLdescriptionstring

    The description of the structure definition

    SHALLcontext-typetoken

    A type of use context assigned to the structure definition

    SHALLexperimentaltoken

    For testing purposes, not real usage

    SHALLtitlestring

    The human-friendly name of the structure definition

    SHALLtypeuri

    Type defined or constrained by this structure

    SHALLcontext-quantityquantity

    A quantity- or range-valued use context assigned to the structure definition

    SHALLpathtoken

    A path that is constrained in the StructureDefinition

    SHALLbase-pathtoken

    Path that identifies the base element

    SHALLcontexttoken

    A use context assigned to the structure definition

    SHALLsd-unique-urlcomposite

    Search parameter for making a structureDefinition unique by URL

    SHALLkeywordtoken

    A code for the StructureDefinition

    SHALLcontext-type-quantitycomposite

    A use context type and quantity- or range-based value assigned to the structure definition

    SHALLidentifiertoken

    External identifier for the structure definition

    SHALLvaluesetreference

    A vocabulary binding reference

    SHALLkindtoken

    primitive-type | complex-type | resource | logical

    SHALL_securitytoken

    Search for resources which have the given security labels

    SHALLabstracttoken

    Whether the structure is abstract

    SHALLversiontoken

    The business version of the structure definition

    SHALLurluri

    Search parameter for finding a structureDefinition by URL

    SHALL_filterstring

    Search the contents of the resource's data using a filter

    SHALL_profileuri

    Search for resources which have the given profile

    SHALLext-contexttoken

    The system is the URL for the context-type: e.g. http://hl7.org/fhir/extension-context-type#element|CodeableConcept.text

    SHALL_hasstring

    Return resources linked to by the given target

    SHALL_tagtoken

    Search for resources which have the given tag

    SHALLnamestring

    Computationally friendly name of the structure definition

    SHALLpublisherstring

    Name of the publisher of the structure definition

    SHALLderivationtoken

    specialization | constraint - How relates to base definition

    SHALL_sourceuri

    Search for resources which have the given source value (Resource.meta.source)

    SHALL_idtoken

    The ID of the resource

    SHALL_contentstring

    Search the contents of the resource's data using a fulltext search

    SHALL_textstring

    Search the contents of the resource's narrative using a fulltext search

    SHALLbasereference

    Definition that this type is constrained/specialized from

    SHALLstatustoken

    The current status of the structure definition

     
    Extended Operations
    ConformanceOperationDocumentation
    SHALL$generateSnapshot
    SHALL$snapshot
    SHALL$validate

    Resource Conformance: supported ValueSet

    Base System Profile
    ValueSet
    Profile Conformance
    SHALL
    Reference Policy

    Interaction summary
    • Supports search-type, vread, read.

    Search Parameters
    ConformanceParameterTypeDocumentation
    SHALL_languagestring

    The language of the resource

    SHALLdatedate

    The value set publication date

    SHALLcodetoken

    This special parameter searches for codes in the value set. See additional notes on the ValueSet resource

    SHALLcontext-type-valuecomposite

    A use context type and value assigned to the value set

    SHALLjurisdictiontoken

    Intended jurisdiction for the value set

    SHALL_lastUpdateddate

    Only return resources which were last updated as specified by the given range

    SHALLdescriptionstring

    The description of the value set

    SHALLcontext-typetoken

    A type of use context assigned to the value set

    SHALLtitlestring

    The human-friendly name of the value set

    SHALLreferenceuri

    A code system included or excluded in the value set or an imported value set

    SHALLcontext-quantityquantity

    A quantity- or range-valued use context assigned to the value set

    SHALLcontexttoken

    A use context assigned to the value set

    SHALLcontext-type-quantitycomposite

    A use context type and quantity- or range-based value assigned to the value set

    SHALLidentifiertoken

    External identifier for the value set

    SHALL_securitytoken

    Search for resources which have the given security labels

    SHALLversiontoken

    The business version of the value set

    SHALLurluri

    The uri that identifies the value set

    SHALLexpansionuri

    Identifies the value set expansion (business identifier)

    SHALL_filterstring

    Search the contents of the resource's data using a filter

    SHALL_profileuri

    Search for resources which have the given profile

    SHALL_hasstring

    Return resources linked to by the given target

    SHALL_tagtoken

    Search for resources which have the given tag

    SHALLnamestring

    Computationally friendly name of the value set

    SHALLpublisherstring

    Name of the publisher of the value set

    SHALL_sourceuri

    Search for resources which have the given source value (Resource.meta.source)

    SHALL_idtoken

    The ID of the resource

    SHALL_contentstring

    Search the contents of the resource's data using a fulltext search

    SHALL_textstring

    Search the contents of the resource's narrative using a fulltext search

    SHALLstatustoken

    The current status of the value set

     
    Extended Operations
    ConformanceOperationDocumentation
    SHALL$expand
    SHALL$validate-code
    SHALL$validate

    Operations

    Use