eHealth Infrastructure
8.0.1 - release DK

This page is part of the FUT Infrastructure (v8.0.1: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

CapabilityStatement: patient

Official URL: http://ehealth.sundhed.dk/fhir/CapabilityStatement/patient Version: 8.0.1
Active as of 2026-02-25 Realm: Denmark flag Computable Name: patient

Raw OpenAPI-Swagger Definition file | Download

  • Implementation Guide Version: 8.0.1
  • 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: 2026-02-25 23:20:08+0000
  • 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.

This CapabilityStatement instantiates the CapabilityStatement http://hl7.org/fhir/uv/bulkdata/CapabilityStatement/bulk-data

FHIR RESTful Capabilities

Mode: server

Security
Enable CORS: no
Security services supported:
Summary of System-wide Operations
ConformanceOperationDocumentation
SHALL$export-poll-status
SHALL$export
SHALL$migrate
SHALL$reindex
SHALL$process-message
SHALL$meta
SHALL$get-resource-counts

Provides the number of resources currently stored on the server, broken down by resource type

SHALL$expunge

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
yyyyyydate, _language, 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, _tag, _has, reason-reference, _source, 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:communicationAbout, Communication:communicationParticipant, Communication:communicationRelatesTo, Communication:episodeOfCare, Communication:on-behalf-of, Communication:part-of, Consent:data, Provenance:entity, Provenance:target$validate, $exportAsiCal, $meta-delete, $meta-add, $meta
Binaryhttp://hl7.org/fhir/StructureDefinition/Binaryyyyyyyyyy_language, _list, _profile, _lastUpdated, _tag, _has, _security, _source, _id, _content, _text, _filter*Appointment:careteamParticipant, Appointment:intended-audience, Appointment:responsible, Appointment:supporting-info, Communication:based-on, Communication:careTeamRecipient, Communication:careTeamSender, Communication:communicationAbout, Communication:communicationParticipant, Communication:communicationRelatesTo, Communication:episodeOfCare, Communication:on-behalf-of, Communication:part-of, Consent:data, Provenance:entity, Provenance:target$validate, $meta-delete, $meta-add, $meta, $expunge
CodeSystemhttp://hl7.org/fhir/StructureDefinition/CodeSystemyyydate, _language, code, context-type-value, _lastUpdated, jurisdiction, description, context-type, language, title, context-quantity, context, context-type-quantity, identifier, content-mode, _security, version, url, _filter, supplements, system, _profile, _tag, _has, 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:communicationAbout, Communication:communicationParticipant, Communication:communicationRelatesTo, Communication:episodeOfCare, Communication:on-behalf-of, Communication:part-of, Consent:data, Provenance:entity, Provenance:target$validate, $subsumes, $lookup
Communicationhttp://hl7.org/fhir/StructureDefinition/Communication
Additional supported profiles:
  ehealth-communication
  ehealth-material-communication
  ehealth-message
yyyyyy_language, administrativeStatus, subject, _lastUpdated, part-of, medium, on-behalf-of, threadId, communicationRelatesTo, based-on, patient, instantiates-uri, communicationAbout, episodeOfCare, identifier, period, _security, communicationParticipant, instantiates-canonical, communicationCategory, received, encounter, careTeamRecipient, communicationGroupId, sent, _filter, _profile, careTeamSender, sender, _tag, _has, recipient, _source, _id, category, restrictionCategory, _content, _text, status*, Communication:based-on, Communication:careTeamRecipient, Communication:careTeamSender, Communication:communicationAbout, Communication:communicationParticipant, Communication:communicationRelatesTo, Communication:encounter, Communication:episodeOfCare, 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:communicationAbout, Communication:communicationParticipant, Communication:communicationRelatesTo, Communication:episodeOfCare, Communication:on-behalf-of, Communication:part-of, Consent:data, Provenance:entity, Provenance:target$validate
Consenthttp://hl7.org/fhir/StructureDefinition/Consent
Additional supported profiles:
  ehealth-access-consent
  ehealth-consent
yyyyyyydate, _language, data, purpose, _lastUpdated, source-reference, _list, patient, scope, action, identifier, period, _security, _filter, actor, security-label, _profile, _tag, organization, _has, _source, consentor, _id, category, _content, _text, status*, Consent:actor, Consent:consentor, Consent:data, Consent:organization, Consent:patient, Consent:source-referenceAppointment:careteamParticipant, Appointment:intended-audience, Appointment:responsible, Appointment:supporting-info, Communication:based-on, Communication:careTeamRecipient, Communication:careTeamSender, Communication:communicationAbout, Communication:communicationParticipant, Communication:communicationRelatesTo, Communication:episodeOfCare, Communication:on-behalf-of, Communication:part-of, Consent:data, Consent:source-reference, Provenance:entity, Provenance:target$validate
Grouphttp://hl7.org/fhir/StructureDefinition/Groupactual, identifier, managing-entity, code, _lastUpdated, _security, type, characteristic, characteristic-value, _profile, _tag, member, _source, exclude, _id, value*, Group:managing-entity, Group:memberAppointment:careteamParticipant, Appointment:intended-audience, Appointment:responsible, Appointment:supporting-info, Communication:based-on, Communication:careTeamRecipient, Communication:careTeamSender, Communication:communicationAbout, Communication:communicationParticipant, Communication:communicationRelatesTo, Communication:episodeOfCare, Communication:on-behalf-of, Communication:part-of, Communication:recipient, Communication:subject, Consent:actor, Consent:data, Consent:patient, Group:member, Provenance:entity, Provenance:target$export
OperationDefinitionhttp://hl7.org/fhir/StructureDefinition/OperationDefinitionydate, code, instance, context-type-value, _lastUpdated, jurisdiction, description, context-type, title, type, context-quantity, output-profile, context, context-type-quantity, kind, _security, version, url, input-profile, system, _profile, _tag, name, publisher, _source, _id, status, base*, 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:communicationAbout, Communication:communicationParticipant, Communication:communicationRelatesTo, Communication:episodeOfCare, Communication:instantiates-canonical, Communication:on-behalf-of, Communication:part-of, Consent:data, OperationDefinition:base, Provenance:entity, Provenance:target
Patienthttp://hl7.org/fhir/StructureDefinition/Patient
Additional supported profiles:
  ehealth-patient
  ehealth-skrs-patient
  Danish Core Patient Profile
yyyybirthdate, deceased, address-state, gender, _lastUpdated, link, patientCPRIdentifier, language, address-country, death-date, phonetic, telecom, address-city, email, given, identifier, patientCPRIdentifierUnique, address, general-practitioner, _security, active, address-postalcode, _profile, phone, _tag, organization, address-use, name, _source, _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:communicationAbout, Communication:communicationParticipant, Communication:communicationRelatesTo, Communication:episodeOfCare, Communication:on-behalf-of, Communication:part-of, Communication:patient, Communication:recipient, Communication:sender, Communication:subject, Consent:actor, Consent:consentor, Consent:data, Consent:patient, Group:member, Patient:link, Person:link, Person:patient, Provenance:agent, Provenance:entity, Provenance:patient, Provenance:target, RelatedPerson:patient$export, $validate, $updatePatientWithSKRSData, $createPatient
Personhttp://hl7.org/fhir/StructureDefinition/Personbirthdate, address-state, gender, _lastUpdated, link, address-country, phonetic, patient, telecom, address-city, email, identifier, address, practitioner, _security, relatedperson, address-postalcode, _profile, phone, _tag, organization, address-use, name, _source, _id*, 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:communicationAbout, Communication:communicationParticipant, Communication:communicationRelatesTo, Communication:episodeOfCare, Communication:on-behalf-of, Communication:part-of, Consent:data, Person:link, Provenance:entity, Provenance:target$match
Provenancehttp://hl7.org/fhir/StructureDefinition/Provenance
Additional supported profiles:
  ehealth-access-provenance
  ehealth-provenance
yyyyyyy_language, agent-type, agent, signature-type, _lastUpdated, _security, recorded, when, target, _filter, _list, _profile, patient, _tag, _has, _source, location, _id, agent-role, _content, _text, entity*, Provenance:agent, Provenance:entity, Provenance:location, Provenance:patient, Provenance:targetAppointment:careteamParticipant, Appointment:intended-audience, Appointment:responsible, Appointment:supporting-info, Communication:based-on, Communication:careTeamRecipient, Communication:careTeamSender, Communication:communicationAbout, Communication:communicationParticipant, Communication:communicationRelatesTo, Communication:episodeOfCare, Communication:on-behalf-of, Communication:part-of, Consent:data, Provenance:entity, Provenance:target$validate
RelatedPersonhttp://hl7.org/fhir/StructureDefinition/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, _tag, _has, address-use, name, _source, _id, _content, _text*, RelatedPerson:patientAppointment:actor, Appointment:careteamParticipant, Appointment:intended-audience, Appointment:responsible, Appointment:supporting-info, Communication:based-on, Communication:careTeamRecipient, Communication:careTeamSender, Communication:communicationAbout, Communication:communicationParticipant, Communication:communicationRelatesTo, Communication:episodeOfCare, Communication:on-behalf-of, Communication:part-of, Communication:recipient, Communication:sender, Consent:actor, Consent:consentor, Consent:data, Group:managing-entity, Patient:link, Person:link, Person:relatedperson, Provenance:agent, Provenance:entity, Provenance:target$validate, $updateRelatedPersonWithSKRSData
SearchParameterhttp://hl7.org/fhir/StructureDefinition/SearchParameteryyydate, _language, code, context-type-value, _lastUpdated, jurisdiction, description, derived-from, context-type, type, context-quantity, context, context-type-quantity, _security, sp-unique-url, version, url, target, _filter, component, _profile, _tag, _has, name, publisher, _source, _id, _content, _text, status, base*, SearchParameter:componentAppointment:careteamParticipant, Appointment:intended-audience, Appointment:responsible, Appointment:supporting-info, Communication:based-on, Communication:careTeamRecipient, Communication:careTeamSender, Communication:communicationAbout, Communication:communicationParticipant, Communication:communicationRelatesTo, Communication:episodeOfCare, Communication:on-behalf-of, Communication:part-of, Consent:data, Provenance:entity, Provenance:target, SearchParameter:component, SearchParameter:derived-from$validate
StructureDefinitionhttp://hl7.org/fhir/StructureDefinition/StructureDefinition
Additional supported profiles:
  ehealth-definedquestion
yyyydate, _language, context-type-value, _lastUpdated, jurisdiction, description, context-type, experimental, title, type, context-quantity, path, context, base-path, sd-unique-url, keyword, context-type-quantity, identifier, valueset, kind, _security, abstract, version, url, _filter, _profile, ext-context, _tag, _has, name, publisher, _source, derivation, _id, _content, _text, status, base*, StructureDefinition:valuesetAppointment:careteamParticipant, Appointment:intended-audience, Appointment:responsible, Appointment:supporting-info, Communication:based-on, Communication:careTeamRecipient, Communication:careTeamSender, Communication:communicationAbout, Communication:communicationParticipant, Communication:communicationRelatesTo, Communication:episodeOfCare, Communication:on-behalf-of, Communication:part-of, Consent:data, OperationDefinition:input-profile, OperationDefinition:output-profile, Provenance:entity, Provenance:target, StructureDefinition:base$validate, $snapshot, $generateSnapshot
ValueSethttp://hl7.org/fhir/StructureDefinition/ValueSetyyydate, _language, code, context-type-value, _lastUpdated, jurisdiction, description, context-type, title, reference, context-quantity, context, context-type-quantity, identifier, _security, version, url, expansion, _filter, _profile, _tag, _has, 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:communicationAbout, Communication:communicationParticipant, Communication:communicationRelatesTo, Communication:episodeOfCare, Communication:on-behalf-of, Communication:part-of, Consent:data, Provenance:entity, Provenance:target, StructureDefinition:valueset$validate-code, $invalidate-expansion, $expand, $validate

Resource Conformance: supported Appointment

Base System Profile
Appointment
Profile Conformance
SHALL
Reference Policy

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALLdatedate

Appointment date/time.

SHALL_languagestring

The language of the resource

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

When the resource version last changed

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

Security Labels applied to this resource

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

Profiles this resource claims to conform to

SHALLintended-audiencereference

Search parameter for finding intended audience on Appointment

SHALL_tagtoken

Tags applied to this resource

SHALL_hasstring

Return resources linked to by the given target

SHALLreason-referencereference

Reason the appointment is to take place (resource)

SHALL_sourceuri

Identifies where the resource comes from

SHALLlocationreference

This location is listed in the participants of the appointment

SHALL_idtoken

Logical id of this artifact

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$validate
SHALL$exportAsiCal
SHALL$meta-delete
SHALL$meta-add
SHALL$meta

Resource Conformance: supported Binary

Base System Profile
Binary
Profile Conformance
SHALL
Reference Policy

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_languagetoken

The language of the resource

SHALL_liststring

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

SHALL_profileuri

Profiles this resource claims to conform to

SHALL_lastUpdateddate

When the resource version last changed

SHALL_tagtoken

Tags applied to this resource

SHALL_hasstring

Return resources linked to by the given target

SHALL_securitytoken

Security Labels applied to this resource

SHALL_sourceuri

Identifies where the resource comes from

SHALL_idtoken

Logical id of this artifact

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

SHALL_filterstring

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

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
SHALL$meta-delete

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

SHALL$meta-add

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

SHALL$meta

Request a list of tags, profiles, and security labels for a specfic resource instance

SHALL$expunge

Resource Conformance: supported CodeSystem

Base System Profile
CodeSystem
Profile Conformance
SHALL
Reference Policy

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALLdatedate

Multiple Resources:

SHALL_languagestring

The language of the resource

SHALLcodetoken

A code defined in the code system

SHALLcontext-type-valuecomposite

Multiple Resources:

SHALL_lastUpdateddate

When the resource version last changed

SHALLjurisdictiontoken

Multiple Resources:

SHALLdescriptionstring

Multiple Resources:

SHALLcontext-typetoken

Multiple Resources:

SHALLlanguagetoken

A language in which a designation is provided

SHALLtitlestring

Multiple Resources:

SHALLcontext-quantityquantity

Multiple Resources:

  • CapabilityStatement: A quantity- or range-valued use context assigned to the capability statement
  • CodeSystem: A quantity- or range-valued use context assigned to the code system
  • CompartmentDefinition: A quantity- or range-valued use context assigned to the compartment definition
  • ConceptMap: A quantity- or range-valued use context assigned to the concept map
  • GraphDefinition: A quantity- or range-valued use context assigned to the graph definition
  • ImplementationGuide: A quantity- or range-valued use context assigned to the implementation guide
  • MessageDefinition: A quantity- or range-valued use context assigned to the message definition
  • NamingSystem: A quantity- or range-valued use context assigned to the naming system
  • OperationDefinition: A quantity- or range-valued use context assigned to the operation definition
  • SearchParameter: A quantity- or range-valued use context assigned to the search parameter
  • StructureDefinition: A quantity- or range-valued use context assigned to the structure definition
  • StructureMap: A quantity- or range-valued use context assigned to the structure map
  • TerminologyCapabilities: A quantity- or range-valued use context assigned to the terminology capabilities
  • ValueSet: A quantity- or range-valued use context assigned to the value set
SHALLcontexttoken

Multiple Resources:

SHALLcontext-type-quantitycomposite

Multiple Resources:

  • CapabilityStatement: A use context type and quantity- or range-based value assigned to the capability statement
  • CodeSystem: A use context type and quantity- or range-based value assigned to the code system
  • CompartmentDefinition: A use context type and quantity- or range-based value assigned to the compartment definition
  • ConceptMap: A use context type and quantity- or range-based value assigned to the concept map
  • GraphDefinition: A use context type and quantity- or range-based value assigned to the graph definition
  • ImplementationGuide: A use context type and quantity- or range-based value assigned to the implementation guide
  • MessageDefinition: A use context type and quantity- or range-based value assigned to the message definition
  • NamingSystem: A use context type and quantity- or range-based value assigned to the naming system
  • OperationDefinition: A use context type and quantity- or range-based value assigned to the operation definition
  • SearchParameter: A use context type and quantity- or range-based value assigned to the search parameter
  • StructureDefinition: A use context type and quantity- or range-based value assigned to the structure definition
  • StructureMap: A use context type and quantity- or range-based value assigned to the structure map
  • TerminologyCapabilities: A use context type and quantity- or range-based value assigned to the terminology capabilities
  • ValueSet: A use context type and quantity- or range-based value assigned to the value set
SHALLidentifiertoken

Multiple Resources:

SHALLcontent-modetoken

not-present | example | fragment | complete | supplement

SHALL_securitytoken

Security Labels applied to this resource

SHALLversiontoken

Multiple Resources:

SHALLurluri

Multiple Resources:

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

Profiles this resource claims to conform to

SHALL_tagtoken

Tags applied to this resource

SHALL_hasstring

Return resources linked to by the given target

SHALLnamestring

Multiple Resources:

SHALLpublisherstring

Multiple Resources:

SHALL_sourceuri

Identifies where the resource comes from

SHALL_idtoken

Logical id of this artifact

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

Multiple Resources:

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

Resource Conformance: supported Communication

Base System Profile
Communication
Profile Conformance
SHALL
Reference Policy

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

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

When the resource version last changed

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

SHALLcommunicationRelatesToreference

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

SHALLbased-onreference

Request fulfilled by this communication

SHALLpatientreference

Focus of message

SHALLinstantiates-uriuri

Instantiates external protocol or definition

SHALLcommunicationAboutreference

Search parameter for finding communication based on about

SHALLepisodeOfCarereference

Search parameter for finding communication based on episodeOfCare

SHALLidentifiertoken

Unique identifier

SHALLperioddate

Search parameter for finding communication based on period

SHALL_securitytoken

Security Labels applied to this resource

SHALLcommunicationParticipantreference

Search parameter for finding communication based on participant

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

SHALLcareTeamRecipientreference

Search parameter for finding communication based on CareTeam recipient

SHALLcommunicationGroupIdstring

Search parameter for finding resources based on group id

SHALLsentdate

When sent

SHALL_filterstring

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

SHALL_profileuri

Profiles this resource claims to conform to

SHALLcareTeamSenderreference

Search parameter for finding communication based on CareTeam sender

SHALLsenderreference

Message sender

SHALL_tagtoken

Tags applied to this resource

SHALL_hasstring

Return resources linked to by the given target

SHALLrecipientreference

Message recipient

SHALL_sourceuri

Identifies where the resource comes from

SHALL_idtoken

Logical id of this artifact

SHALLcategorytoken

Message category

SHALLrestrictionCategorytoken

Search parameter for finding communication based on restriction category

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 Consent

Base System Profile
Consent
Profile Conformance
SHALL
Reference Policy

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALLdatedate

Multiple Resources:

SHALL_languagetoken

The language of the resource

SHALLdatareference

The actual data reference

SHALLpurposetoken

Context of activities covered by this rule

SHALL_lastUpdateddate

When the resource version last changed

SHALLsource-referencereference

Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse

SHALL_liststring

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

SHALLpatientreference

Multiple Resources:

SHALLscopetoken

Which of the four areas this resource covers (extensible)

SHALLactiontoken

Actions controlled by this rule

SHALLidentifiertoken

Multiple Resources:

SHALLperioddate

Timeframe for this rule

SHALL_securitytoken

Security Labels applied to this resource

SHALL_filterstring

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

SHALLactorreference

Resource for the actor (or group, by role)

SHALLsecurity-labeltoken

Security Labels that define affected resources

SHALL_profileuri

Profiles this resource claims to conform to

SHALL_tagtoken

Tags applied to this resource

SHALLorganizationreference

Custodian of the consent

SHALL_hasstring

Return resources linked to by the given target

SHALL_sourceuri

Identifies where the resource comes from

SHALLconsentorreference

Who is agreeing to the policy and rules

SHALL_idtoken

Logical id of this artifact

SHALLcategorytoken

Classification of the consent statement - for indexing/retrieval

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

draft | proposed | active | rejected | inactive | entered-in-error

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate

Resource Conformance: supported Group

Base System Profile
Group
Profile Conformance
SHALL
Reference Policy

Interaction summary

    Search Parameters
    ConformanceParameterTypeDocumentation
    SHALLactualtoken

    Descriptive or actual

    SHALLidentifiertoken

    Unique id

    SHALLmanaging-entityreference

    Entity that is the custodian of the Group's definition

    SHALLcodetoken

    The kind of resources contained

    SHALL_lastUpdateddate

    When the resource version last changed

    SHALL_securitytoken

    Security Labels applied to this resource

    SHALLtypetoken

    The type of resources the group contains

    SHALLcharacteristictoken

    Kind of characteristic

    SHALLcharacteristic-valuecomposite

    A composite of both characteristic and value

    SHALL_profileuri

    Profiles this resource claims to conform to

    SHALL_tagtoken

    Tags applied to this resource

    SHALLmemberreference

    Reference to the group member

    SHALL_sourceuri

    Identifies where the resource comes from

    SHALLexcludetoken

    Group includes or excludes

    SHALL_idtoken

    Logical id of this artifact

    SHALLvaluetoken

    Value held by characteristic

     
    Extended Operations
    ConformanceOperationDocumentation
    SHALL$export

    Resource Conformance: supported OperationDefinition

    Base System Profile
    OperationDefinition
    Profile Conformance
    SHALL
    Reference Policy

    Interaction summary
    • Supports read.

    Search Parameters
    ConformanceParameterTypeDocumentation
    SHALLdatedate

    Multiple Resources:

    SHALLcodetoken

    Name used to invoke the operation

    SHALLinstancetoken

    Invoke on an instance?

    SHALLcontext-type-valuecomposite

    Multiple Resources:

    SHALL_lastUpdateddate

    When the resource version last changed

    SHALLjurisdictiontoken

    Multiple Resources:

    SHALLdescriptionstring

    Multiple Resources:

    SHALLcontext-typetoken

    Multiple Resources:

    SHALLtitlestring

    Multiple Resources:

    SHALLtypetoken

    Invoke at the type level?

    SHALLcontext-quantityquantity

    Multiple Resources:

    • CapabilityStatement: A quantity- or range-valued use context assigned to the capability statement
    • CodeSystem: A quantity- or range-valued use context assigned to the code system
    • CompartmentDefinition: A quantity- or range-valued use context assigned to the compartment definition
    • ConceptMap: A quantity- or range-valued use context assigned to the concept map
    • GraphDefinition: A quantity- or range-valued use context assigned to the graph definition
    • ImplementationGuide: A quantity- or range-valued use context assigned to the implementation guide
    • MessageDefinition: A quantity- or range-valued use context assigned to the message definition
    • NamingSystem: A quantity- or range-valued use context assigned to the naming system
    • OperationDefinition: A quantity- or range-valued use context assigned to the operation definition
    • SearchParameter: A quantity- or range-valued use context assigned to the search parameter
    • StructureDefinition: A quantity- or range-valued use context assigned to the structure definition
    • StructureMap: A quantity- or range-valued use context assigned to the structure map
    • TerminologyCapabilities: A quantity- or range-valued use context assigned to the terminology capabilities
    • ValueSet: A quantity- or range-valued use context assigned to the value set
    SHALLoutput-profilereference

    Validation information for out parameters

    SHALLcontexttoken

    Multiple Resources:

    SHALLcontext-type-quantitycomposite

    Multiple Resources:

    • CapabilityStatement: A use context type and quantity- or range-based value assigned to the capability statement
    • CodeSystem: A use context type and quantity- or range-based value assigned to the code system
    • CompartmentDefinition: A use context type and quantity- or range-based value assigned to the compartment definition
    • ConceptMap: A use context type and quantity- or range-based value assigned to the concept map
    • GraphDefinition: A use context type and quantity- or range-based value assigned to the graph definition
    • ImplementationGuide: A use context type and quantity- or range-based value assigned to the implementation guide
    • MessageDefinition: A use context type and quantity- or range-based value assigned to the message definition
    • NamingSystem: A use context type and quantity- or range-based value assigned to the naming system
    • OperationDefinition: A use context type and quantity- or range-based value assigned to the operation definition
    • SearchParameter: A use context type and quantity- or range-based value assigned to the search parameter
    • StructureDefinition: A use context type and quantity- or range-based value assigned to the structure definition
    • StructureMap: A use context type and quantity- or range-based value assigned to the structure map
    • TerminologyCapabilities: A use context type and quantity- or range-based value assigned to the terminology capabilities
    • ValueSet: A use context type and quantity- or range-based value assigned to the value set
    SHALLkindtoken

    operation | query

    SHALL_securitytoken

    Security Labels applied to this resource

    SHALLversiontoken

    Multiple Resources:

    SHALLurluri

    Multiple Resources:

    SHALLinput-profilereference

    Validation information for in parameters

    SHALLsystemtoken

    Invoke at the system level?

    SHALL_profileuri

    Profiles this resource claims to conform to

    SHALL_tagtoken

    Tags applied to this resource

    SHALLnamestring

    Multiple Resources:

    SHALLpublisherstring

    Multiple Resources:

    SHALL_sourceuri

    Identifies where the resource comes from

    SHALL_idtoken

    Logical id of this artifact

    SHALLstatustoken

    Multiple Resources:

    SHALLbasereference

    Marks this as a profile of the base

     

    Resource Conformance: supported Patient

    Base System Profile
    Patient
    Profile Conformance
    SHALL
    Reference Policy

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

    Search Parameters
    ConformanceParameterTypeDocumentation
    SHALLbirthdatedate

    Multiple Resources:

    SHALLdeceasedtoken

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

    SHALLaddress-statestring

    Multiple Resources:

    SHALLgendertoken

    Multiple Resources:

    SHALL_lastUpdateddate

    When the resource version last changed

    SHALLlinkreference

    All patients linked to the given patient

    SHALLpatientCPRIdentifiertoken

    Search parameter for Patient DK-Core CPR identifier

    SHALLlanguagetoken

    Language code (irrespective of use value)

    SHALLaddress-countrystring

    Multiple Resources:

    SHALLdeath-datedate

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

    SHALLphoneticstring

    Multiple Resources:

    • Patient: A portion of either family or given name using some kind of phonetic matching algorithm
    • Person: A portion of name using some kind of phonetic matching algorithm
    • Practitioner: A portion of either family or given name using some kind of phonetic matching algorithm
    • RelatedPerson: A portion of name using some kind of phonetic matching algorithm
    SHALLtelecomtoken

    Multiple Resources:

    SHALLaddress-citystring

    Multiple Resources:

    SHALLemailtoken

    Multiple Resources:

    SHALLgivenstring

    Multiple Resources:

    SHALLidentifiertoken

    A patient identifier

    SHALLpatientCPRIdentifierUniquetoken

    Uniqueness constraint on search parameter patientCPRIdentifier

    SHALLaddressstring

    Multiple Resources:

    • Patient: 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
    • Person: 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
    • Practitioner: 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
    • RelatedPerson: 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

    Security Labels applied to this resource

    SHALLactivetoken

    Whether the patient record is active

    SHALLaddress-postalcodestring

    Multiple Resources:

    SHALL_profileuri

    Profiles this resource claims to conform to

    SHALLphonetoken

    Multiple Resources:

    SHALL_tagtoken

    Tags applied to this resource

    SHALLorganizationreference

    The organization that is the custodian of the patient record

    SHALLaddress-usetoken

    Multiple Resources:

    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_sourceuri

    Identifies where the resource comes from

    SHALL_idtoken

    Logical id of this artifact

    SHALLfamilystring

    Multiple Resources:

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

    Resource Conformance: supported Person

    Base System Profile
    Person
    Profile Conformance
    SHALL
    Reference Policy

    Interaction summary

      Search Parameters
      ConformanceParameterTypeDocumentation
      SHALLbirthdatedate

      Multiple Resources:

      SHALLaddress-statestring

      Multiple Resources:

      SHALLgendertoken

      Multiple Resources:

      SHALL_lastUpdateddate

      When the resource version last changed

      SHALLlinkreference

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

      SHALLaddress-countrystring

      Multiple Resources:

      SHALLphoneticstring

      Multiple Resources:

      • Patient: A portion of either family or given name using some kind of phonetic matching algorithm
      • Person: A portion of name using some kind of phonetic matching algorithm
      • Practitioner: A portion of either family or given name using some kind of phonetic matching algorithm
      • RelatedPerson: A portion of name using some kind of phonetic matching algorithm
      SHALLpatientreference

      The Person links to this Patient

      SHALLtelecomtoken

      Multiple Resources:

      SHALLaddress-citystring

      Multiple Resources:

      SHALLemailtoken

      Multiple Resources:

      SHALLidentifiertoken

      A person Identifier

      SHALLaddressstring

      Multiple Resources:

      • Patient: 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
      • Person: 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
      • Practitioner: 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
      • RelatedPerson: 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
      SHALLpractitionerreference

      The Person links to this Practitioner

      SHALL_securitytoken

      Security Labels applied to this resource

      SHALLrelatedpersonreference

      The Person links to this RelatedPerson

      SHALLaddress-postalcodestring

      Multiple Resources:

      SHALL_profileuri

      Profiles this resource claims to conform to

      SHALLphonetoken

      Multiple Resources:

      SHALL_tagtoken

      Tags applied to this resource

      SHALLorganizationreference

      The organization at which this person record is being managed

      SHALLaddress-usetoken

      Multiple Resources:

      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_sourceuri

      Identifies where the resource comes from

      SHALL_idtoken

      Logical id of this artifact

       
      Extended Operations
      ConformanceOperationDocumentation
      SHALL$match

      Resource Conformance: supported Provenance

      Base System Profile
      Provenance
      Profile Conformance
      SHALL
      Reference Policy

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

      Search Parameters
      ConformanceParameterTypeDocumentation
      SHALL_languagetoken

      The language of the resource

      SHALLagent-typetoken

      How the agent participated

      SHALLagentreference

      Who participated

      SHALLsignature-typetoken

      Indication of the reason the entity signed the object(s)

      SHALL_lastUpdateddate

      When the resource version last changed

      SHALL_securitytoken

      Security Labels applied to this resource

      SHALLrecordeddate

      When the activity was recorded / updated

      SHALLwhendate

      When the activity occurred

      SHALLtargetreference

      Target Reference(s) (usually version specific)

      SHALL_filterstring

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

      SHALL_liststring

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

      SHALL_profileuri

      Profiles this resource claims to conform to

      SHALLpatientreference

      Target Reference(s) (usually version specific)

      SHALL_tagtoken

      Tags applied to this resource

      SHALL_hasstring

      Return resources linked to by the given target

      SHALL_sourceuri

      Identifies where the resource comes from

      SHALLlocationreference

      Where the activity occurred, if relevant

      SHALL_idtoken

      Logical id of this artifact

      SHALLagent-roletoken

      What the agents role was

      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

      SHALLentityreference

      Identity of entity

       
      Extended Operations
      ConformanceOperationDocumentation
      SHALL$validate

      Resource Conformance: supported RelatedPerson

      Base System Profile
      RelatedPerson
      Profile Conformance
      SHALL
      Reference Policy

      Supported Profiles

      ehealth-relatedperson

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

      Search Parameters
      ConformanceParameterTypeDocumentation
      SHALL_languagestring

      The language of the resource

      SHALLbirthdatedate

      Multiple Resources:

      SHALLaddress-statestring

      Multiple Resources:

      SHALLgendertoken

      Multiple Resources:

      SHALL_lastUpdateddate

      When the resource version last changed

      SHALLaddress-countrystring

      Multiple Resources:

      SHALLphoneticstring

      Multiple Resources:

      • Patient: A portion of either family or given name using some kind of phonetic matching algorithm
      • Person: A portion of name using some kind of phonetic matching algorithm
      • Practitioner: A portion of either family or given name using some kind of phonetic matching algorithm
      • RelatedPerson: A portion of name using some kind of phonetic matching algorithm
      SHALLpatientreference

      The patient this related person is related to

      SHALLtelecomtoken

      Multiple Resources:

      SHALLaddress-citystring

      Multiple Resources:

      SHALLrelationshiptoken

      The relationship between the patient and the relatedperson

      SHALLemailtoken

      Multiple Resources:

      SHALLidentifiertoken

      An Identifier of the RelatedPerson

      SHALLaddressstring

      Multiple Resources:

      • Patient: 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
      • Person: 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
      • Practitioner: 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
      • RelatedPerson: 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

      Security Labels applied to this resource

      SHALLactivetoken

      Indicates if the related person record is active

      SHALLaddress-postalcodestring

      Multiple Resources:

      SHALL_profileuri

      Profiles this resource claims to conform to

      SHALLphonetoken

      Multiple Resources:

      SHALL_tagtoken

      Tags applied to this resource

      SHALL_hasstring

      Return resources linked to by the given target

      SHALLaddress-usetoken

      Multiple Resources:

      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_sourceuri

      Identifies where the resource comes from

      SHALL_idtoken

      Logical id of this artifact

      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
      SHALL$updateRelatedPersonWithSKRSData

      Resource Conformance: supported SearchParameter

      Base System Profile
      SearchParameter
      Profile Conformance
      SHALL
      Reference Policy

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

      Search Parameters
      ConformanceParameterTypeDocumentation
      SHALLdatedate

      Multiple Resources:

      SHALL_languagestring

      The language of the resource

      SHALLcodetoken

      Code used in URL

      SHALLcontext-type-valuecomposite

      Multiple Resources:

      SHALL_lastUpdateddate

      When the resource version last changed

      SHALLjurisdictiontoken

      Multiple Resources:

      SHALLdescriptionstring

      Multiple Resources:

      SHALLderived-fromreference

      Original definition for the search parameter

      SHALLcontext-typetoken

      Multiple Resources:

      SHALLtypetoken

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

      SHALLcontext-quantityquantity

      Multiple Resources:

      • CapabilityStatement: A quantity- or range-valued use context assigned to the capability statement
      • CodeSystem: A quantity- or range-valued use context assigned to the code system
      • CompartmentDefinition: A quantity- or range-valued use context assigned to the compartment definition
      • ConceptMap: A quantity- or range-valued use context assigned to the concept map
      • GraphDefinition: A quantity- or range-valued use context assigned to the graph definition
      • ImplementationGuide: A quantity- or range-valued use context assigned to the implementation guide
      • MessageDefinition: A quantity- or range-valued use context assigned to the message definition
      • NamingSystem: A quantity- or range-valued use context assigned to the naming system
      • OperationDefinition: A quantity- or range-valued use context assigned to the operation definition
      • SearchParameter: A quantity- or range-valued use context assigned to the search parameter
      • StructureDefinition: A quantity- or range-valued use context assigned to the structure definition
      • StructureMap: A quantity- or range-valued use context assigned to the structure map
      • TerminologyCapabilities: A quantity- or range-valued use context assigned to the terminology capabilities
      • ValueSet: A quantity- or range-valued use context assigned to the value set
      SHALLcontexttoken

      Multiple Resources:

      SHALLcontext-type-quantitycomposite

      Multiple Resources:

      • CapabilityStatement: A use context type and quantity- or range-based value assigned to the capability statement
      • CodeSystem: A use context type and quantity- or range-based value assigned to the code system
      • CompartmentDefinition: A use context type and quantity- or range-based value assigned to the compartment definition
      • ConceptMap: A use context type and quantity- or range-based value assigned to the concept map
      • GraphDefinition: A use context type and quantity- or range-based value assigned to the graph definition
      • ImplementationGuide: A use context type and quantity- or range-based value assigned to the implementation guide
      • MessageDefinition: A use context type and quantity- or range-based value assigned to the message definition
      • NamingSystem: A use context type and quantity- or range-based value assigned to the naming system
      • OperationDefinition: A use context type and quantity- or range-based value assigned to the operation definition
      • SearchParameter: A use context type and quantity- or range-based value assigned to the search parameter
      • StructureDefinition: A use context type and quantity- or range-based value assigned to the structure definition
      • StructureMap: A use context type and quantity- or range-based value assigned to the structure map
      • TerminologyCapabilities: A use context type and quantity- or range-based value assigned to the terminology capabilities
      • ValueSet: A use context type and quantity- or range-based value assigned to the value set
      SHALL_securitytoken

      Security Labels applied to this resource

      SHALLsp-unique-urlcomposite

      Search parameter for making a SearchParameter unique by URL

      SHALLversiontoken

      Multiple Resources:

      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

      Profiles this resource claims to conform to

      SHALL_tagtoken

      Tags applied to this resource

      SHALL_hasstring

      Return resources linked to by the given target

      SHALLnamestring

      Multiple Resources:

      SHALLpublisherstring

      Multiple Resources:

      SHALL_sourceuri

      Identifies where the resource comes from

      SHALL_idtoken

      Logical id of this artifact

      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

      Multiple Resources:

      SHALLbasetoken

      The resource type(s) this search parameter applies to

       
      Extended Operations
      ConformanceOperationDocumentation
      SHALL$validate

      Resource Conformance: supported StructureDefinition

      Base System Profile
      StructureDefinition
      Profile Conformance
      SHALL
      Reference Policy

      Supported Profiles

      ehealth-definedquestion

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

      Search Parameters
      ConformanceParameterTypeDocumentation
      SHALLdatedate

      Multiple Resources:

      SHALL_languagestring

      The language of the resource

      SHALLcontext-type-valuecomposite

      Multiple Resources:

      SHALL_lastUpdateddate

      When the resource version last changed

      SHALLjurisdictiontoken

      Multiple Resources:

      SHALLdescriptionstring

      Multiple Resources:

      SHALLcontext-typetoken

      Multiple Resources:

      SHALLexperimentaltoken

      For testing purposes, not real usage

      SHALLtitlestring

      Multiple Resources:

      SHALLtypeuri

      Type defined or constrained by this structure

      SHALLcontext-quantityquantity

      Multiple Resources:

      • CapabilityStatement: A quantity- or range-valued use context assigned to the capability statement
      • CodeSystem: A quantity- or range-valued use context assigned to the code system
      • CompartmentDefinition: A quantity- or range-valued use context assigned to the compartment definition
      • ConceptMap: A quantity- or range-valued use context assigned to the concept map
      • GraphDefinition: A quantity- or range-valued use context assigned to the graph definition
      • ImplementationGuide: A quantity- or range-valued use context assigned to the implementation guide
      • MessageDefinition: A quantity- or range-valued use context assigned to the message definition
      • NamingSystem: A quantity- or range-valued use context assigned to the naming system
      • OperationDefinition: A quantity- or range-valued use context assigned to the operation definition
      • SearchParameter: A quantity- or range-valued use context assigned to the search parameter
      • StructureDefinition: A quantity- or range-valued use context assigned to the structure definition
      • StructureMap: A quantity- or range-valued use context assigned to the structure map
      • TerminologyCapabilities: A quantity- or range-valued use context assigned to the terminology capabilities
      • ValueSet: A quantity- or range-valued use context assigned to the value set
      SHALLpathtoken

      A path that is constrained in the StructureDefinition

      SHALLcontexttoken

      Multiple Resources:

      SHALLbase-pathtoken

      Path that identifies the base element

      SHALLsd-unique-urlcomposite

      Search parameter for making a structureDefinition unique by URL

      SHALLkeywordtoken

      A code for the StructureDefinition

      SHALLcontext-type-quantitycomposite

      Multiple Resources:

      • CapabilityStatement: A use context type and quantity- or range-based value assigned to the capability statement
      • CodeSystem: A use context type and quantity- or range-based value assigned to the code system
      • CompartmentDefinition: A use context type and quantity- or range-based value assigned to the compartment definition
      • ConceptMap: A use context type and quantity- or range-based value assigned to the concept map
      • GraphDefinition: A use context type and quantity- or range-based value assigned to the graph definition
      • ImplementationGuide: A use context type and quantity- or range-based value assigned to the implementation guide
      • MessageDefinition: A use context type and quantity- or range-based value assigned to the message definition
      • NamingSystem: A use context type and quantity- or range-based value assigned to the naming system
      • OperationDefinition: A use context type and quantity- or range-based value assigned to the operation definition
      • SearchParameter: A use context type and quantity- or range-based value assigned to the search parameter
      • StructureDefinition: A use context type and quantity- or range-based value assigned to the structure definition
      • StructureMap: A use context type and quantity- or range-based value assigned to the structure map
      • TerminologyCapabilities: A use context type and quantity- or range-based value assigned to the terminology capabilities
      • ValueSet: A use context type and quantity- or range-based value assigned to the value set
      SHALLidentifiertoken

      Multiple Resources:

      SHALLvaluesetreference

      A vocabulary binding reference

      SHALLkindtoken

      primitive-type | complex-type | resource | logical

      SHALL_securitytoken

      Security Labels applied to this resource

      SHALLabstracttoken

      Whether the structure is abstract

      SHALLversiontoken

      Multiple Resources:

      SHALLurluri

      Search parameter for finding a structureDefinition by URL

      SHALL_filterstring

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

      SHALL_profileuri

      Profiles this resource claims to conform to

      SHALLext-contexttoken

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

      SHALL_tagtoken

      Tags applied to this resource

      SHALL_hasstring

      Return resources linked to by the given target

      SHALLnamestring

      Multiple Resources:

      SHALLpublisherstring

      Multiple Resources:

      SHALL_sourceuri

      Identifies where the resource comes from

      SHALLderivationtoken

      specialization | constraint - How relates to base definition

      SHALL_idtoken

      Logical id of this artifact

      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

      Multiple Resources:

      SHALLbasereference

      Definition that this type is constrained/specialized from

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

      Resource Conformance: supported ValueSet

      Base System Profile
      ValueSet
      Profile Conformance
      SHALL
      Reference Policy

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

      Search Parameters
      ConformanceParameterTypeDocumentation
      SHALLdatedate

      Multiple Resources:

      SHALL_languagestring

      The language of the resource

      SHALLcodetoken

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

      SHALLcontext-type-valuecomposite

      Multiple Resources:

      SHALL_lastUpdateddate

      When the resource version last changed

      SHALLjurisdictiontoken

      Multiple Resources:

      SHALLdescriptionstring

      Multiple Resources:

      SHALLcontext-typetoken

      Multiple Resources:

      SHALLtitlestring

      Multiple Resources:

      SHALLreferenceuri

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

      SHALLcontext-quantityquantity

      Multiple Resources:

      • CapabilityStatement: A quantity- or range-valued use context assigned to the capability statement
      • CodeSystem: A quantity- or range-valued use context assigned to the code system
      • CompartmentDefinition: A quantity- or range-valued use context assigned to the compartment definition
      • ConceptMap: A quantity- or range-valued use context assigned to the concept map
      • GraphDefinition: A quantity- or range-valued use context assigned to the graph definition
      • ImplementationGuide: A quantity- or range-valued use context assigned to the implementation guide
      • MessageDefinition: A quantity- or range-valued use context assigned to the message definition
      • NamingSystem: A quantity- or range-valued use context assigned to the naming system
      • OperationDefinition: A quantity- or range-valued use context assigned to the operation definition
      • SearchParameter: A quantity- or range-valued use context assigned to the search parameter
      • StructureDefinition: A quantity- or range-valued use context assigned to the structure definition
      • StructureMap: A quantity- or range-valued use context assigned to the structure map
      • TerminologyCapabilities: A quantity- or range-valued use context assigned to the terminology capabilities
      • ValueSet: A quantity- or range-valued use context assigned to the value set
      SHALLcontexttoken

      Multiple Resources:

      SHALLcontext-type-quantitycomposite

      Multiple Resources:

      • CapabilityStatement: A use context type and quantity- or range-based value assigned to the capability statement
      • CodeSystem: A use context type and quantity- or range-based value assigned to the code system
      • CompartmentDefinition: A use context type and quantity- or range-based value assigned to the compartment definition
      • ConceptMap: A use context type and quantity- or range-based value assigned to the concept map
      • GraphDefinition: A use context type and quantity- or range-based value assigned to the graph definition
      • ImplementationGuide: A use context type and quantity- or range-based value assigned to the implementation guide
      • MessageDefinition: A use context type and quantity- or range-based value assigned to the message definition
      • NamingSystem: A use context type and quantity- or range-based value assigned to the naming system
      • OperationDefinition: A use context type and quantity- or range-based value assigned to the operation definition
      • SearchParameter: A use context type and quantity- or range-based value assigned to the search parameter
      • StructureDefinition: A use context type and quantity- or range-based value assigned to the structure definition
      • StructureMap: A use context type and quantity- or range-based value assigned to the structure map
      • TerminologyCapabilities: A use context type and quantity- or range-based value assigned to the terminology capabilities
      • ValueSet: A use context type and quantity- or range-based value assigned to the value set
      SHALLidentifiertoken

      Multiple Resources:

      SHALL_securitytoken

      Security Labels applied to this resource

      SHALLversiontoken

      Multiple Resources:

      SHALLurluri

      Multiple Resources:

      SHALLexpansionuri

      Identifies the value set expansion (business identifier)

      SHALL_filterstring

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

      SHALL_profileuri

      Profiles this resource claims to conform to

      SHALL_tagtoken

      Tags applied to this resource

      SHALL_hasstring

      Return resources linked to by the given target

      SHALLnamestring

      Multiple Resources:

      SHALLpublisherstring

      Multiple Resources:

      SHALL_sourceuri

      Identifies where the resource comes from

      SHALL_idtoken

      Logical id of this artifact

      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

      Multiple Resources:

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