{
"description": "HL7 AU example provider directory service capability statement",
"_filename": "CapabilityStatement-au-pd-capability.json",
"package_name": "hl7.fhir.au.pd",
"format": [ "xml", "json" ],
"date": "2018-10-25",
"publisher": "HL7 AU",
"fhirVersion": "3.0.1",
"name": "au-pd-capability",
"acceptUnknown": "extensions",
"copyright": "HL7 AU",
"type": null,
"experimental": "true",
"resourceType": "CapabilityStatement",
"title": null,
"package_version": "0.9.0",
"status": "active",
"id": "adc5bb36-8cc6-4ae9-9170-4b492db1913d",
"kind": "instance",
"url": "http://hl7.org.au/fhir/pd/CapabilityStatement/au-pd-capability",
"version": "1.0",
"rest": [ {
"mode": "server",
"resource": [ {
"searchParam": [ {
"name": "address",
"type": "string"
}, {
"name": "address-city",
"type": "string"
}, {
"name": "address-country",
"type": "string"
}, {
"name": "address-postalcode",
"type": "string"
}, {
"name": "address-state",
"type": "string"
}, {
"name": "address-use",
"type": "token"
}, {
"name": "email",
"type": "token"
}, {
"name": "family",
"type": "string"
}, {
"name": "gender",
"type": "token"
}, {
"name": "given",
"type": "string"
}, {
"name": "phone",
"type": "token"
}, {
"name": "phonetic",
"type": "string"
}, {
"name": "telecom",
"type": "token"
}, {
"name": "active",
"type": "token",
"documentation": "Whether the practitioner record is active"
}, {
"name": "communication",
"type": "token",
"documentation": "One of the languages that the practitioner can communicate with"
}, {
"name": "identifier",
"type": "token",
"documentation": "A practitioner's Identifier"
}, {
"name": "name",
"type": "string",
"documentation": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text"
} ],
"conditionalUpdate": true,
"readHistory": true,
"type": "Practitioner",
"interaction": [ {
"code": "create"
}, {
"code": "read"
}, {
"code": "update"
}, {
"code": "delete"
}, {
"code": "search-type"
}, {
"code": "vread"
}, {
"code": "history-instance"
}, {
"code": "history-type"
} ],
"updateCreate": true,
"conditionalCreate": true,
"versioning": "versioned",
"conditionalDelete": "single"
}, {
"searchParam": [ {
"name": "active",
"type": "token",
"documentation": "A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text"
}, {
"name": "address",
"type": "string",
"documentation": "A (part of the) address of the organization"
}, {
"name": "address-city",
"type": "string",
"documentation": "A city specified in an address"
}, {
"name": "address-country",
"type": "string",
"documentation": "A country specified in an address"
}, {
"name": "address-postalcode",
"type": "string",
"documentation": "A postal code specified in an address"
}, {
"name": "address-state",
"type": "string",
"documentation": "A state specified in an address"
}, {
"name": "address-use",
"type": "token",
"documentation": "A use code specified in an address"
}, {
"name": "endpoint",
"type": "reference",
"documentation": "Technical endpoints providing access to services operated for the organization"
}, {
"name": "identifier",
"type": "token",
"documentation": "Any identifier for the organization (not the accreditation issuer's identifier)"
}, {
"name": "name",
"type": "string",
"documentation": "A portion of the organization's name or alias"
}, {
"name": "partof",
"type": "reference",
"documentation": "An organization of which this organization forms a part"
}, {
"name": "phonetic",
"type": "string",
"documentation": "A portion of the organization's name using some kind of phonetic matching algorithm"
}, {
"name": "type",
"type": "token",
"documentation": "A code for the type of organization"
} ],
"conditionalUpdate": true,
"readHistory": true,
"type": "Organization",
"interaction": [ {
"code": "create"
}, {
"code": "read"
}, {
"code": "update"
}, {
"code": "delete"
}, {
"code": "search-type"
}, {
"code": "vread"
}, {
"code": "history-instance"
}, {
"code": "history-type"
} ],
"updateCreate": true,
"conditionalCreate": true,
"searchInclude": [ "endpoint", "partof" ],
"versioning": "versioned",
"conditionalDelete": "single"
}, {
"searchParam": [ {
"name": "date",
"type": "date",
"documentation": "The value set publication date"
}, {
"name": "description",
"type": "string",
"documentation": "The description of the value set"
}, {
"name": "expansion",
"type": "uri",
"documentation": "Uniquely identifies this expansion"
}, {
"name": "identifier",
"type": "token",
"documentation": "External identifier for the value set"
}, {
"name": "jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the value set"
}, {
"name": "name",
"type": "string",
"documentation": "Computationally friendly name of the value set"
}, {
"name": "publisher",
"type": "string",
"documentation": "Name of the publisher of the value set"
}, {
"name": "reference",
"type": "uri",
"documentation": "A code system included or excluded in the value set or an imported value set"
}, {
"name": "status",
"type": "token",
"documentation": "The current status of the value set"
}, {
"name": "title",
"type": "string",
"documentation": "The human-friendly name of the value set"
}, {
"name": "url",
"type": "uri",
"documentation": "The uri that identifies the value set"
}, {
"name": "version",
"type": "token",
"documentation": "The business version of the value set"
} ],
"conditionalUpdate": true,
"readHistory": true,
"type": "ValueSet",
"interaction": [ {
"code": "create"
}, {
"code": "read"
}, {
"code": "update"
}, {
"code": "delete"
}, {
"code": "search-type"
}, {
"code": "vread"
}, {
"code": "history-instance"
}, {
"code": "history-type"
} ],
"updateCreate": true,
"conditionalCreate": true,
"versioning": "versioned",
"conditionalDelete": "single"
}, {
"searchParam": [ {
"name": "address",
"type": "string",
"documentation": "A (part of the) address of the location"
}, {
"name": "address-city",
"type": "string",
"documentation": "A city specified in an address"
}, {
"name": "address-country",
"type": "string",
"documentation": "A country specified in an address"
}, {
"name": "address-postalcode",
"type": "string",
"documentation": "A postal code specified in an address"
}, {
"name": "address-state",
"type": "string",
"documentation": "A state specified in an address"
}, {
"name": "address-use",
"type": "token",
"documentation": "A use code specified in an address"
}, {
"name": "endpoint",
"type": "reference",
"documentation": "Technical endpoints providing access to services operated for the location"
}, {
"name": "identifier",
"type": "token",
"documentation": "An identifier for the location"
}, {
"name": "name",
"type": "string",
"documentation": "A portion of the location's name or alias"
}, {
"name": "near",
"type": "token",
"documentation": "The coordinates expressed as [latitude]:[longitude] (using the WGS84 datum, see notes) to find locations near to (servers may search using a square rather than a circle for efficiency)\r\n\r\nRequires the near-distance parameter to be provided also"
}, {
"name": "near-distance",
"type": "quantity",
"documentation": "A distance quantity to limit the near search to locations within a specific distance\r\n\r\nRequires the near parameter to also be included"
}, {
"name": "operational-status",
"type": "token",
"documentation": "Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping)"
}, {
"name": "organization",
"type": "reference",
"documentation": "Searches for locations that are managed by the provided organization"
}, {
"name": "partof",
"type": "reference",
"documentation": "A location of which this location is a part"
}, {
"name": "status",
"type": "token",
"documentation": "Searches for locations with a specific kind of status"
}, {
"name": "type",
"type": "token",
"documentation": "A code for the type of location"
} ],
"conditionalUpdate": true,
"readHistory": true,
"type": "Location",
"interaction": [ {
"code": "create"
}, {
"code": "read"
}, {
"code": "update"
}, {
"code": "delete"
}, {
"code": "search-type"
}, {
"code": "vread"
}, {
"code": "history-instance"
}, {
"code": "history-type"
} ],
"updateCreate": true,
"conditionalCreate": true,
"searchInclude": [ "endpoint", "organization", "partof" ],
"versioning": "versioned",
"conditionalDelete": "single"
}, {
"searchParam": [ {
"name": "email",
"type": "token"
}, {
"name": "phone",
"type": "token"
}, {
"name": "telecom",
"type": "token"
}, {
"name": "active",
"type": "token",
"documentation": "Whether this practitioner's record is in active use"
}, {
"name": "date",
"type": "date",
"documentation": "The period during which the practitioner is authorized to perform in these role(s)"
}, {
"name": "endpoint",
"type": "reference",
"documentation": "Technical endpoints providing access to services operated for the practitioner with this role"
}, {
"name": "identifier",
"type": "token",
"documentation": "A practitioner's Identifier"
}, {
"name": "location",
"type": "reference",
"documentation": "One of the locations at which this practitioner provides care"
}, {
"name": "organization",
"type": "reference",
"documentation": "The identity of the organization the practitioner represents / acts on behalf of"
}, {
"name": "practitioner",
"type": "reference",
"documentation": "Practitioner that is able to provide the defined services for the organation"
}, {
"name": "role",
"type": "token",
"documentation": "The practitioner can perform this role at for the organization"
}, {
"name": "service",
"type": "reference",
"documentation": "The list of healthcare services that this worker provides for this role's Organization/Location(s)"
}, {
"name": "specialty",
"type": "token",
"documentation": "The practitioner has this specialty at an organization"
} ],
"conditionalUpdate": true,
"readHistory": true,
"type": "PractitionerRole",
"interaction": [ {
"code": "create"
}, {
"code": "read"
}, {
"code": "update"
}, {
"code": "delete"
}, {
"code": "search-type"
}, {
"code": "vread"
}, {
"code": "history-instance"
}, {
"code": "history-type"
} ],
"updateCreate": true,
"conditionalCreate": true,
"searchInclude": [ "endpoint", "location", "organization", "practitioner", "service" ],
"versioning": "versioned",
"conditionalDelete": "single"
}, {
"searchParam": [ {
"name": "action",
"type": "token",
"documentation": "Type of action performed during the event"
}, {
"name": "address",
"type": "string",
"documentation": "Identifier for the network access point of the user device"
}, {
"name": "agent",
"type": "reference",
"documentation": "Direct reference to resource"
}, {
"name": "agent-name",
"type": "string",
"documentation": "Human-meaningful name for the agent"
}, {
"name": "agent-role",
"type": "token",
"documentation": "Agent role in the event"
}, {
"name": "altid",
"type": "token",
"documentation": "Alternative User id e.g. authentication"
}, {
"name": "date",
"type": "date",
"documentation": "Time when the event occurred on source"
}, {
"name": "entity",
"type": "reference",
"documentation": "Specific instance of resource"
}, {
"name": "entity-id",
"type": "token",
"documentation": "Specific instance of object"
}, {
"name": "entity-name",
"type": "string",
"documentation": "Descriptor for entity"
}, {
"name": "entity-role",
"type": "token",
"documentation": "What role the entity played"
}, {
"name": "entity-type",
"type": "token",
"documentation": "Type of entity involved"
}, {
"name": "outcome",
"type": "token",
"documentation": "Whether the event succeeded or failed"
}, {
"name": "patient",
"type": "reference",
"documentation": "Direct reference to resource"
}, {
"name": "policy",
"type": "uri",
"documentation": "Policy that authorized event"
}, {
"name": "site",
"type": "token",
"documentation": "Logical source location within the enterprise"
}, {
"name": "source",
"type": "token",
"documentation": "The identity of source detecting the event"
}, {
"name": "subtype",
"type": "token",
"documentation": "More specific type/id for the event"
}, {
"name": "type",
"type": "token",
"documentation": "Type/identifier of event"
}, {
"name": "user",
"type": "token",
"documentation": "Unique identifier for the user"
} ],
"conditionalUpdate": true,
"readHistory": true,
"type": "AuditEvent",
"interaction": [ {
"code": "create"
}, {
"code": "read"
}, {
"code": "update"
}, {
"code": "delete"
}, {
"code": "search-type"
}, {
"code": "vread"
}, {
"code": "history-instance"
}, {
"code": "history-type"
} ],
"updateCreate": true,
"conditionalCreate": true,
"searchInclude": [ "agent", "entity", "patient" ],
"versioning": "versioned",
"conditionalDelete": "single"
}, {
"searchParam": [ {
"name": "code",
"type": "token",
"documentation": "A code that corresponds to one of its items in the questionnaire"
}, {
"name": "date",
"type": "date",
"documentation": "The questionnaire publication date"
}, {
"name": "description",
"type": "string",
"documentation": "The description of the questionnaire"
}, {
"name": "effective",
"type": "date",
"documentation": "The time during which the questionnaire is intended to be in use"
}, {
"name": "identifier",
"type": "token",
"documentation": "External identifier for the questionnaire"
}, {
"name": "jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the questionnaire"
}, {
"name": "name",
"type": "string",
"documentation": "Computationally friendly name of the questionnaire"
}, {
"name": "publisher",
"type": "string",
"documentation": "Name of the publisher of the questionnaire"
}, {
"name": "status",
"type": "token",
"documentation": "The current status of the questionnaire"
}, {
"name": "title",
"type": "string",
"documentation": "The human-friendly name of the questionnaire"
}, {
"name": "url",
"type": "uri",
"documentation": "The uri that identifies the questionnaire"
}, {
"name": "version",
"type": "token",
"documentation": "The business version of the questionnaire"
} ],
"conditionalUpdate": true,
"readHistory": true,
"type": "Questionnaire",
"interaction": [ {
"code": "create"
}, {
"code": "read"
}, {
"code": "update"
}, {
"code": "delete"
}, {
"code": "search-type"
}, {
"code": "vread"
}, {
"code": "history-instance"
}, {
"code": "history-type"
} ],
"updateCreate": true,
"conditionalCreate": true,
"versioning": "versioned",
"conditionalDelete": "single"
}, {
"searchParam": [ {
"name": "author",
"type": "reference",
"documentation": "The author of the questionnaire response"
}, {
"name": "authored",
"type": "date",
"documentation": "When the questionnaire response was last changed"
}, {
"name": "based-on",
"type": "reference",
"documentation": "Plan/proposal/order fulfilled by this questionnaire response"
}, {
"name": "context",
"type": "reference",
"documentation": "Encounter or episode associated with the questionnaire response"
}, {
"name": "identifier",
"type": "token",
"documentation": "The unique identifier for the questionnaire response"
}, {
"name": "parent",
"type": "reference",
"documentation": "Procedure or observation this questionnaire response was performed as a part of"
}, {
"name": "patient",
"type": "reference",
"documentation": "The patient that is the subject of the questionnaire response"
}, {
"name": "questionnaire",
"type": "reference",
"documentation": "The questionnaire the answers are provided for"
}, {
"name": "source",
"type": "reference",
"documentation": "The individual providing the information reflected in the questionnaire respose"
}, {
"name": "status",
"type": "token",
"documentation": "The status of the questionnaire response"
}, {
"name": "subject",
"type": "reference",
"documentation": "The subject of the questionnaire response"
} ],
"conditionalUpdate": true,
"readHistory": true,
"type": "QuestionnaireResponse",
"interaction": [ {
"code": "create"
}, {
"code": "read"
}, {
"code": "update"
}, {
"code": "delete"
}, {
"code": "search-type"
}, {
"code": "vread"
}, {
"code": "history-instance"
}, {
"code": "history-type"
} ],
"updateCreate": true,
"conditionalCreate": true,
"searchInclude": [ "author", "based-on", "context", "parent", "patient", "questionnaire", "source", "subject" ],
"versioning": "versioned",
"conditionalDelete": "single"
}, {
"searchParam": [ {
"name": "code",
"type": "token",
"documentation": "A code defined in the code system"
}, {
"name": "content-mode",
"type": "token",
"documentation": "not-present | example | fragment | complete"
}, {
"name": "date",
"type": "date",
"documentation": "The code system publication date"
}, {
"name": "description",
"type": "string",
"documentation": "The description of the code system"
}, {
"name": "identifier",
"type": "token",
"documentation": "External identifier for the code system"
}, {
"name": "jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the code system"
}, {
"name": "language",
"type": "token",
"documentation": "A language in which a designation is provided"
}, {
"name": "name",
"type": "string",
"documentation": "Computationally friendly name of the code system"
}, {
"name": "publisher",
"type": "string",
"documentation": "Name of the publisher of the code system"
}, {
"name": "status",
"type": "token",
"documentation": "The current status of the code system"
}, {
"name": "system",
"type": "uri",
"documentation": "The system for any codes defined by this code system (same as 'url')"
}, {
"name": "title",
"type": "string",
"documentation": "The human-friendly name of the code system"
}, {
"name": "url",
"type": "uri",
"documentation": "The uri that identifies the code system"
}, {
"name": "version",
"type": "token",
"documentation": "The business version of the code system"
} ],
"conditionalUpdate": true,
"readHistory": true,
"type": "CodeSystem",
"interaction": [ {
"code": "create"
}, {
"code": "read"
}, {
"code": "update"
}, {
"code": "delete"
}, {
"code": "search-type"
}, {
"code": "vread"
}, {
"code": "history-instance"
}, {
"code": "history-type"
} ],
"updateCreate": true,
"conditionalCreate": true,
"versioning": "versioned",
"conditionalDelete": "single"
}, {
"searchParam": [ {
"name": "active",
"type": "token",
"documentation": "The Healthcare Service is currently marked as active"
}, {
"name": "category",
"type": "token",
"documentation": "Service Category of the Healthcare Service"
}, {
"name": "characteristic",
"type": "token",
"documentation": "One of the HealthcareService's characteristics"
}, {
"name": "endpoint",
"type": "reference",
"documentation": "Technical endpoints providing access to services operated for the location"
}, {
"name": "identifier",
"type": "token",
"documentation": "External identifiers for this item"
}, {
"name": "location",
"type": "reference",
"documentation": "The location of the Healthcare Service"
}, {
"name": "name",
"type": "string",
"documentation": "A portion of the Healthcare service name"
}, {
"name": "organization",
"type": "reference",
"documentation": "The organization that provides this Healthcare Service"
}, {
"name": "programname",
"type": "string",
"documentation": "One of the Program Names serviced by this HealthcareService"
}, {
"name": "type",
"type": "token",
"documentation": "The type of service provided by this healthcare service"
} ],
"conditionalUpdate": true,
"readHistory": true,
"type": "HealthcareService",
"interaction": [ {
"code": "create"
}, {
"code": "read"
}, {
"code": "update"
}, {
"code": "delete"
}, {
"code": "search-type"
}, {
"code": "vread"
}, {
"code": "history-instance"
}, {
"code": "history-type"
} ],
"updateCreate": true,
"conditionalCreate": true,
"searchInclude": [ "endpoint", "location", "organization" ],
"versioning": "versioned",
"conditionalDelete": "single"
}, {
"searchParam": [ {
"name": "base",
"type": "reference",
"documentation": "Marks this as a profile of the base"
}, {
"name": "code",
"type": "token",
"documentation": "Name used to invoke the operation"
}, {
"name": "date",
"type": "date",
"documentation": "The operation definition publication date"
}, {
"name": "description",
"type": "string",
"documentation": "The description of the operation definition"
}, {
"name": "instance",
"type": "token",
"documentation": "Invoke on an instance?"
}, {
"name": "jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the operation definition"
}, {
"name": "kind",
"type": "token",
"documentation": "operation | query"
}, {
"name": "name",
"type": "string",
"documentation": "Computationally friendly name of the operation definition"
}, {
"name": "param-profile",
"type": "reference",
"documentation": "Profile on the type"
}, {
"name": "publisher",
"type": "string",
"documentation": "Name of the publisher of the operation definition"
}, {
"name": "status",
"type": "token",
"documentation": "The current status of the operation definition"
}, {
"name": "system",
"type": "token",
"documentation": "Invoke at the system level?"
}, {
"name": "type",
"type": "token",
"documentation": "Invole at the type level?"
}, {
"name": "url",
"type": "uri",
"documentation": "The uri that identifies the operation definition"
}, {
"name": "version",
"type": "token",
"documentation": "The business version of the operation definition"
} ],
"conditionalUpdate": true,
"readHistory": true,
"type": "OperationDefinition",
"interaction": [ {
"code": "create"
}, {
"code": "read"
}, {
"code": "update"
}, {
"code": "delete"
}, {
"code": "search-type"
}, {
"code": "vread"
}, {
"code": "history-instance"
}, {
"code": "history-type"
} ],
"updateCreate": true,
"conditionalCreate": true,
"searchInclude": [ "base", "param-profile" ],
"versioning": "versioned",
"conditionalDelete": "single"
}, {
"searchParam": [ {
"name": "abstract",
"type": "token",
"documentation": "Whether the structure is abstract"
}, {
"name": "base",
"type": "uri",
"documentation": "Definition that this type is constrained/specialized from"
}, {
"name": "base-path",
"type": "token",
"documentation": "Path that identifies the base element"
}, {
"name": "context-type",
"type": "token",
"documentation": "resource | datatype | extension"
}, {
"name": "date",
"type": "date",
"documentation": "The structure definition publication date"
}, {
"name": "derivation",
"type": "token",
"documentation": "specialization | constraint - How relates to base definition"
}, {
"name": "description",
"type": "string",
"documentation": "The description of the structure definition"
}, {
"name": "experimental",
"type": "token",
"documentation": "For testing purposes, not real usage"
}, {
"name": "ext-context",
"type": "string",
"documentation": "Where the extension can be used in instances"
}, {
"name": "identifier",
"type": "token",
"documentation": "External identifier for the structure definition"
}, {
"name": "jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the structure definition"
}, {
"name": "keyword",
"type": "token",
"documentation": "A code for the profile"
}, {
"name": "kind",
"type": "token",
"documentation": "primitive-type | complex-type | resource | logical"
}, {
"name": "name",
"type": "string",
"documentation": "Computationally friendly name of the structure definition"
}, {
"name": "path",
"type": "token",
"documentation": "A path that is constrained in the profile"
}, {
"name": "publisher",
"type": "string",
"documentation": "Name of the publisher of the structure definition"
}, {
"name": "status",
"type": "token",
"documentation": "The current status of the structure definition"
}, {
"name": "title",
"type": "string",
"documentation": "The human-friendly name of the structure definition"
}, {
"name": "type",
"type": "token",
"documentation": "Type defined or constrained by this structure"
}, {
"name": "url",
"type": "uri",
"documentation": "The uri that identifies the structure definition"
}, {
"name": "valueset",
"type": "reference",
"documentation": "A vocabulary binding reference"
}, {
"name": "version",
"type": "token",
"documentation": "The business version of the structure definition"
} ],
"conditionalUpdate": true,
"readHistory": true,
"type": "StructureDefinition",
"interaction": [ {
"code": "create"
}, {
"code": "read"
}, {
"code": "update"
}, {
"code": "delete"
}, {
"code": "search-type"
}, {
"code": "vread"
}, {
"code": "history-instance"
}, {
"code": "history-type"
} ],
"updateCreate": true,
"conditionalCreate": true,
"searchInclude": [ "valueset" ],
"versioning": "versioned",
"conditionalDelete": "single"
}, {
"searchParam": [ {
"name": "date",
"type": "date",
"documentation": "The concept map publication date"
}, {
"name": "dependson",
"type": "uri",
"documentation": "Reference to property mapping depends on"
}, {
"name": "description",
"type": "string",
"documentation": "The description of the concept map"
}, {
"name": "identifier",
"type": "token",
"documentation": "External identifier for the concept map"
}, {
"name": "jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the concept map"
}, {
"name": "name",
"type": "string",
"documentation": "Computationally friendly name of the concept map"
}, {
"name": "other",
"type": "uri",
"documentation": "Canonical URL for other concept map"
}, {
"name": "product",
"type": "uri",
"documentation": "Reference to property mapping depends on"
}, {
"name": "publisher",
"type": "string",
"documentation": "Name of the publisher of the concept map"
}, {
"name": "source",
"type": "reference",
"documentation": "Identifies the source of the concepts which are being mapped"
}, {
"name": "source-code",
"type": "token",
"documentation": "Identifies element being mapped"
}, {
"name": "source-system",
"type": "uri",
"documentation": "Code System (if value set crosses code systems)"
}, {
"name": "source-uri",
"type": "reference",
"documentation": "Identifies the source of the concepts which are being mapped"
}, {
"name": "status",
"type": "token",
"documentation": "The current status of the concept map"
}, {
"name": "target",
"type": "reference",
"documentation": "Provides context to the mappings"
}, {
"name": "target-code",
"type": "token",
"documentation": "Code that identifies the target element"
}, {
"name": "target-system",
"type": "uri",
"documentation": "System of the target (if necessary)"
}, {
"name": "target-uri",
"type": "reference",
"documentation": "Provides context to the mappings"
}, {
"name": "title",
"type": "string",
"documentation": "The human-friendly name of the concept map"
}, {
"name": "url",
"type": "uri",
"documentation": "The uri that identifies the concept map"
}, {
"name": "version",
"type": "token",
"documentation": "The business version of the concept map"
} ],
"conditionalUpdate": true,
"readHistory": true,
"type": "ConceptMap",
"interaction": [ {
"code": "create"
}, {
"code": "read"
}, {
"code": "update"
}, {
"code": "delete"
}, {
"code": "search-type"
}, {
"code": "vread"
}, {
"code": "history-instance"
}, {
"code": "history-type"
} ],
"updateCreate": true,
"conditionalCreate": true,
"searchInclude": [ "source", "source-uri", "target", "target-uri" ],
"versioning": "versioned",
"conditionalDelete": "single"
}, {
"searchParam": [ {
"name": "base",
"type": "token",
"documentation": "The resource type(s) this search parameter applies to"
}, {
"name": "code",
"type": "token",
"documentation": "Code used in URL"
}, {
"name": "component",
"type": "reference",
"documentation": "Defines how the part works"
}, {
"name": "date",
"type": "date",
"documentation": "The search parameter publication date"
}, {
"name": "derived-from",
"type": "uri",
"documentation": "Original Definition for the search parameter"
}, {
"name": "description",
"type": "string",
"documentation": "The description of the search parameter"
}, {
"name": "jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the search parameter"
}, {
"name": "name",
"type": "string",
"documentation": "Computationally friendly name of the search parameter"
}, {
"name": "publisher",
"type": "string",
"documentation": "Name of the publisher of the search parameter"
}, {
"name": "status",
"type": "token",
"documentation": "The current status of the search parameter"
}, {
"name": "target",
"type": "token",
"documentation": "Types of resource (if a resource reference)"
}, {
"name": "type",
"type": "token",
"documentation": "number | date | string | token | reference | composite | quantity | uri"
}, {
"name": "url",
"type": "uri",
"documentation": "The uri that identifies the search parameter"
}, {
"name": "version",
"type": "token",
"documentation": "The business version of the search parameter"
} ],
"conditionalUpdate": true,
"readHistory": true,
"type": "SearchParameter",
"interaction": [ {
"code": "create"
}, {
"code": "read"
}, {
"code": "update"
}, {
"code": "delete"
}, {
"code": "search-type"
}, {
"code": "vread"
}, {
"code": "history-instance"
}, {
"code": "history-type"
} ],
"updateCreate": true,
"conditionalCreate": true,
"searchInclude": [ "component" ],
"versioning": "versioned",
"conditionalDelete": "single"
}, {
"searchParam": [ {
"name": "connection-type",
"type": "token",
"documentation": "Protocol/Profile/Standard to be used with this endpoint connection"
}, {
"name": "identifier",
"type": "token",
"documentation": "Identifies this endpoint across multiple systems"
}, {
"name": "name",
"type": "string",
"documentation": "A name that this endpoint can be identified by"
}, {
"name": "organization",
"type": "reference",
"documentation": "The organization that is managing the endpoint"
}, {
"name": "payload-type",
"type": "token",
"documentation": "The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)"
}, {
"name": "status",
"type": "token",
"documentation": "The current status of the Endpoint (usually expected to be active)"
}, {
"name": "au-receivingfacility-namespace-id",
"type": "token",
"documentation": "HL7 V2 Receiving Application"
}, {
"name": "au-receivingfacility-universal-id",
"type": "token",
"documentation": "HL7 V2 Receiving Facility"
}, {
"name": "au-receivingfacility-universal-id-type",
"type": "token",
"documentation": "HL7 V2 Assigning Authority"
} ],
"conditionalUpdate": true,
"readHistory": true,
"type": "Endpoint",
"interaction": [ {
"code": "create"
}, {
"code": "read"
}, {
"code": "update"
}, {
"code": "delete"
}, {
"code": "search-type"
}, {
"code": "vread"
}, {
"code": "history-instance"
}, {
"code": "history-type"
} ],
"updateCreate": true,
"conditionalCreate": true,
"searchInclude": [ "organization" ],
"versioning": "versioned",
"conditionalDelete": "single"
}, {
"searchParam": [ {
"name": "date",
"type": "date",
"documentation": "The implementation guide publication date"
}, {
"name": "dependency",
"type": "uri",
"documentation": "Where to find dependency"
}, {
"name": "description",
"type": "string",
"documentation": "The description of the implementation guide"
}, {
"name": "experimental",
"type": "token",
"documentation": "For testing purposes, not real usage"
}, {
"name": "jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the implementation guide"
}, {
"name": "name",
"type": "string",
"documentation": "Computationally friendly name of the implementation guide"
}, {
"name": "publisher",
"type": "string",
"documentation": "Name of the publisher of the implementation guide"
}, {
"name": "resource",
"type": "reference",
"documentation": "Location of the resource"
}, {
"name": "status",
"type": "token",
"documentation": "The current status of the implementation guide"
}, {
"name": "url",
"type": "uri",
"documentation": "The uri that identifies the implementation guide"
}, {
"name": "version",
"type": "token",
"documentation": "The business version of the implementation guide"
} ],
"conditionalUpdate": true,
"readHistory": true,
"type": "ImplementationGuide",
"interaction": [ {
"code": "create"
}, {
"code": "read"
}, {
"code": "update"
}, {
"code": "delete"
}, {
"code": "search-type"
}, {
"code": "vread"
}, {
"code": "history-instance"
}, {
"code": "history-type"
} ],
"updateCreate": true,
"conditionalCreate": true,
"searchInclude": [ "resource" ],
"versioning": "versioned",
"conditionalDelete": "single"
}, {
"searchParam": [ {
"name": "add-tag",
"type": "token",
"documentation": "A tag to be added to the resource matching the criteria"
}, {
"name": "contact",
"type": "token",
"documentation": "Contact details for the subscription"
}, {
"name": "criteria",
"type": "string",
"documentation": "The search rules used to determine when to send a notification"
}, {
"name": "payload",
"type": "string",
"documentation": "The mime-type of the notification payload"
}, {
"name": "status",
"type": "token",
"documentation": "The current state of the subscription"
}, {
"name": "type",
"type": "token",
"documentation": "The type of channel for the sent notifications"
}, {
"name": "url",
"type": "uri",
"documentation": "The uri that will receive the notifications"
} ],
"conditionalUpdate": true,
"readHistory": true,
"type": "Subscription",
"interaction": [ {
"code": "create"
}, {
"code": "read"
}, {
"code": "update"
}, {
"code": "delete"
}, {
"code": "search-type"
}, {
"code": "vread"
}, {
"code": "history-instance"
}, {
"code": "history-type"
} ],
"updateCreate": true,
"conditionalCreate": true,
"versioning": "versioned",
"conditionalDelete": "single"
}, {
"type": "OperationOutcome",
"versioning": "versioned",
"interaction": [ {
"code": "create"
}, {
"code": "read"
}, {
"code": "update"
}, {
"code": "delete"
}, {
"code": "search-type"
}, {
"code": "vread"
}, {
"code": "history-instance"
}, {
"code": "history-type"
} ],
"readHistory": true,
"updateCreate": true,
"conditionalCreate": true,
"conditionalDelete": "single",
"conditionalUpdate": true
} ],
"security": {
"cors": true
},
"operation": [ {
"name": "registered-endpoints",
"definition": {
"display": "Registered Endpoints"
}
} ]
} ]
}