Skip to content

Instantly share code, notes, and snippets.

@masnick
Created April 23, 2023 18:29
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save masnick/4ae69f88c498a98f65d40a1098bcc9f6 to your computer and use it in GitHub Desktop.
Save masnick/4ae69f88c498a98f65d40a1098bcc9f6 to your computer and use it in GitHub Desktop.
This file has been truncated, but you can view the full file.
{
"resourceType": "CapabilityStatement",
"id": "56f84ad0-40bd-47ec-a5fa-d8b116137939",
"name": "RestServer",
"status": "active",
"date": "2023-04-23T18:27:32.431+00:00",
"publisher": "Not provided",
"copyright": "This server is **Open Source Software**, licensed under the terms of the [Apache Software License 2.0](https://www.apache.org/licenses/LICENSE-2.0).",
"kind": "instance",
"software": {
"name": "HAPI FHIR Server",
"version": "6.5.12-SNAPSHOT/e500b23fe6/2023-04-06"
},
"implementation": {
"description": "HAPI FHIR Test/Demo Server R4 Endpoint",
"url": "https://hapi.fhir.org/baseR4"
},
"fhirVersion": "4.0.1",
"format": [ "application/fhir+xml", "xml", "application/fhir+json", "json", "application/x-turtle", "ttl", "html/json", "html/xml", "html/turtle" ],
"patchFormat": [ "application/fhir+json", "application/fhir+xml", "application/json-patch+json", "application/xml-patch+xml" ],
"rest": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-websocket",
"valueUri": "/websocketR4"
} ],
"mode": "server",
"resource": [ {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 1003
} ],
"type": "Account",
"profile": "http://hl7.org/fhir/StructureDefinition/Account",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "Account:owner", "Account:patient", "Account:subject" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ChargeItem:account", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "Encounter:account", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Invoice:account", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "owner",
"definition": "http://hl7.org/fhir/SearchParameter/Account-owner",
"type": "reference",
"documentation": "Entity managing the Account"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Account-identifier",
"type": "token",
"documentation": "Account number"
}, {
"name": "period",
"definition": "http://hl7.org/fhir/SearchParameter/Account-period",
"type": "date",
"documentation": "Transaction window"
}, {
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Account-subject",
"type": "reference",
"documentation": "The entity that caused the expenses"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/Account-type",
"type": "token",
"documentation": "E.g. patient, expense, depreciation"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/Account-patient",
"type": "reference",
"documentation": "The entity that caused the expenses"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/Account-name",
"type": "string",
"documentation": "Human-readable label"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Account-status",
"type": "token",
"documentation": "active | inactive | entered-in-error | on-hold | unknown"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 852
} ],
"type": "ActivityDefinition",
"profile": "http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"supportedProfile": [ "http://hl7.org.nz/fhir/StructureDefinition/CcaActivityDefinition" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "CarePlan:instantiates-canonical", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:instantiates-canonical", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:instantiates-canonical", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "FamilyMemberHistory:instantiates-canonical", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageDefinition:parent", "MessageHeader:focus", "NutritionOrder:instantiates-canonical", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:definition", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Procedure:instantiates-canonical", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "ServiceRequest:instantiates-canonical", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-date",
"type": "date",
"documentation": "The activity definition publication date"
}, {
"name": "successor",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-successor",
"type": "reference",
"documentation": "What resource is being referenced"
}, {
"name": "context-type-value",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-context-type-value",
"type": "composite",
"documentation": "A use context type and value assigned to the activity definition"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the activity definition"
}, {
"name": "derived-from",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-derived-from",
"type": "reference",
"documentation": "What resource is being referenced"
}, {
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-description",
"type": "string",
"documentation": "The description of the activity definition"
}, {
"name": "context-type",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-context-type",
"type": "token",
"documentation": "A type of use context assigned to the activity definition"
}, {
"name": "predecessor",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-predecessor",
"type": "reference",
"documentation": "What resource is being referenced"
}, {
"name": "composed-of",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-composed-of",
"type": "reference",
"documentation": "What resource is being referenced"
}, {
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-title",
"type": "string",
"documentation": "The human-friendly name of the activity definition"
}, {
"name": "context-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-context-quantity",
"type": "quantity",
"documentation": "A quantity- or range-valued use context assigned to the activity definition"
}, {
"name": "depends-on",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-depends-on",
"type": "reference",
"documentation": "What resource is being referenced"
}, {
"name": "effective",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-effective",
"type": "date",
"documentation": "The time during which the activity definition is intended to be in use"
}, {
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-context",
"type": "token",
"documentation": "A use context assigned to the activity definition"
}, {
"name": "context-type-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-context-type-quantity",
"type": "composite",
"documentation": "A use context type and quantity- or range-based value assigned to the activity definition"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-identifier",
"type": "token",
"documentation": "External identifier for the activity definition"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-version",
"type": "token",
"documentation": "The business version of the activity definition"
}, {
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-url",
"type": "uri",
"documentation": "The uri that identifies the activity definition"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-name",
"type": "string",
"documentation": "Computationally friendly name of the activity definition"
}, {
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-publisher",
"type": "string",
"documentation": "Name of the publisher of the activity definition"
}, {
"name": "topic",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-topic",
"type": "token",
"documentation": "Topics associated with the module"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-status",
"type": "token",
"documentation": "The current status of the activity definition"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 477
} ],
"type": "AdverseEvent",
"profile": "http://hl7.org/fhir/StructureDefinition/AdverseEvent",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "AdverseEvent:location", "AdverseEvent:recorder", "AdverseEvent:resultingcondition", "AdverseEvent:study", "AdverseEvent:subject", "AdverseEvent:substance" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/AdverseEvent-date",
"type": "date",
"documentation": "When the event occurred"
}, {
"name": "severity",
"definition": "http://hl7.org/fhir/SearchParameter/AdverseEvent-severity",
"type": "token",
"documentation": "mild | moderate | severe"
}, {
"name": "recorder",
"definition": "http://hl7.org/fhir/SearchParameter/AdverseEvent-recorder",
"type": "reference",
"documentation": "Who recorded the adverse event"
}, {
"name": "study",
"definition": "http://hl7.org/fhir/SearchParameter/AdverseEvent-study",
"type": "reference",
"documentation": "AdverseEvent.study"
}, {
"name": "actuality",
"definition": "http://hl7.org/fhir/SearchParameter/AdverseEvent-actuality",
"type": "token",
"documentation": "actual | potential"
}, {
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/AdverseEvent-subject",
"type": "reference",
"documentation": "Subject impacted by event"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "resultingcondition",
"definition": "http://hl7.org/fhir/SearchParameter/AdverseEvent-resultingcondition",
"type": "reference",
"documentation": "Effect on the subject due to this event"
}, {
"name": "substance",
"definition": "http://hl7.org/fhir/SearchParameter/AdverseEvent-substance",
"type": "reference",
"documentation": "Refers to the specific entity that caused the adverse event"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "seriousness",
"definition": "http://hl7.org/fhir/SearchParameter/AdverseEvent-seriousness",
"type": "token",
"documentation": "Seriousness of the event"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/AdverseEvent-location",
"type": "reference",
"documentation": "Location where adverse event occurred"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/AdverseEvent-category",
"type": "token",
"documentation": "product-problem | product-quality | product-use-error | wrong-dose | incorrect-prescribing-information | wrong-technique | wrong-route-of-administration | wrong-rate | wrong-duration | wrong-time | expired-drug | medical-device-use-error | problem-different-manufacturer | unsafe-physical-environment"
}, {
"name": "event",
"definition": "http://hl7.org/fhir/SearchParameter/AdverseEvent-event",
"type": "token",
"documentation": "Type of the event itself in relation to the subject"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 14397
} ],
"type": "AllergyIntolerance",
"profile": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance",
"supportedProfile": [ "http://example.org/fhir/StructureDefinition/CRSAllergyIntolerance", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance-S123", "http://hl7.org/fhir/uv/ips/StructureDefinition/AllergyIntolerance-uv-ips", "https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-allergyintolerance" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "AllergyIntolerance:asserter", "AllergyIntolerance:patient", "AllergyIntolerance:recorder" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:problem", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "verification-status",
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-verification-status",
"type": "token",
"documentation": "unconfirmed | confirmed | refuted | entered-in-error"
}, {
"name": "criticality",
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-criticality",
"type": "token",
"documentation": "low | high | unable-to-assess"
}, {
"name": "clinical-status",
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-clinical-status",
"type": "token",
"documentation": "active | inactive | resolved"
}, {
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name": "severity",
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-severity",
"type": "token",
"documentation": "mild | moderate | severe (of event as a whole)"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name": "manifestation",
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-manifestation",
"type": "token",
"documentation": "Clinical symptoms/signs associated with the Event"
}, {
"name": "recorder",
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-recorder",
"type": "reference",
"documentation": "Who recorded the sensitivity"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "onset",
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-onset",
"type": "date",
"documentation": "Date(/time) when manifestations showed"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "asserter",
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-asserter",
"type": "reference",
"documentation": "Source of the information about the allergy"
}, {
"name": "route",
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-route",
"type": "token",
"documentation": "How the subject was exposed to the substance"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-category",
"type": "token",
"documentation": "food | medication | environment | biologic"
}, {
"name": "last-date",
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-last-date",
"type": "date",
"documentation": "Date(/time) of last known occurrence of a reaction"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 35808
} ],
"type": "Appointment",
"profile": "http://hl7.org/fhir/StructureDefinition/Appointment",
"supportedProfile": [ "http://ehealthontario.on.ca/fhir/StructureDefinition/eReferral-appointment" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "Appointment:actor", "Appointment:based-on", "Appointment:location", "Appointment:patient", "Appointment:practitioner", "Appointment:reason-reference", "Appointment:slot", "Appointment:supporting-info" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AppointmentResponse:appointment", "AuditEvent:entity", "Basic:subject", "CarePlan:activity-reference", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "Encounter:appointment", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImagingStudy:basedon", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-date",
"type": "date",
"documentation": "Appointment date/time."
}, {
"name": "specialty",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-specialty",
"type": "token",
"documentation": "The specialty of a practitioner that would be required to perform the service requested in this appointment"
}, {
"name": "service-category",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-service-category",
"type": "token",
"documentation": "A broad categorization of the service that is to be performed during this appointment"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "slot",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-slot",
"type": "reference",
"documentation": "The slots that this appointment is filling"
}, {
"name": "reason-code",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-reason-code",
"type": "token",
"documentation": "Coded reason this appointment is scheduled"
}, {
"name": "based-on",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-based-on",
"type": "reference",
"documentation": "The service request this appointment is allocated to assess"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-patient",
"type": "reference",
"documentation": "One of the individuals of the appointment is this patient"
}, {
"name": "supporting-info",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-supporting-info",
"type": "reference",
"documentation": "Additional information to support the appointment"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-identifier",
"type": "token",
"documentation": "An Identifier of the Appointment"
}, {
"name": "practitioner",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-practitioner",
"type": "reference",
"documentation": "One of the individuals of the appointment is this practitioner"
}, {
"name": "appointment-type",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-appointment-type",
"type": "token",
"documentation": "The style of appointment or patient that has been booked in the slot (not service type)"
}, {
"name": "part-status",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-part-status",
"type": "token",
"documentation": "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."
}, {
"name": "service-type",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-service-type",
"type": "token",
"documentation": "The specific service that is to be performed during this appointment"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "actor",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-actor",
"type": "reference",
"documentation": "Any one of the individuals participating in the appointment"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "reason-reference",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-reason-reference",
"type": "reference",
"documentation": "Reason the appointment is to take place (resource)"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-location",
"type": "reference",
"documentation": "This location is listed in the participants of the appointment"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Appointment-status",
"type": "token",
"documentation": "The overall status of the appointment"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 615
} ],
"type": "AppointmentResponse",
"profile": "http://hl7.org/fhir/StructureDefinition/AppointmentResponse",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "AppointmentResponse:actor", "AppointmentResponse:appointment", "AppointmentResponse:location", "AppointmentResponse:patient", "AppointmentResponse:practitioner" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImagingStudy:basedon", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/AppointmentResponse-identifier",
"type": "token",
"documentation": "An Identifier in this appointment response"
}, {
"name": "practitioner",
"definition": "http://hl7.org/fhir/SearchParameter/AppointmentResponse-practitioner",
"type": "reference",
"documentation": "This Response is for this Practitioner"
}, {
"name": "part-status",
"definition": "http://hl7.org/fhir/SearchParameter/AppointmentResponse-part-status",
"type": "token",
"documentation": "The participants acceptance status for this appointment"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "appointment",
"definition": "http://hl7.org/fhir/SearchParameter/AppointmentResponse-appointment",
"type": "reference",
"documentation": "The appointment that the response is attached to"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "actor",
"definition": "http://hl7.org/fhir/SearchParameter/AppointmentResponse-actor",
"type": "reference",
"documentation": "The Person, Location/HealthcareService or Device that this appointment response replies for"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/AppointmentResponse-patient",
"type": "reference",
"documentation": "This Response is for this Patient"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/AppointmentResponse-location",
"type": "reference",
"documentation": "This Response is for this Location"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 52511
} ],
"type": "AuditEvent",
"profile": "http://hl7.org/fhir/StructureDefinition/AuditEvent",
"supportedProfile": [ "http://hl7.org/fhir/uv/saner/StructureDefinition/AuditEventBase", "http://hl7.org/fhir/uv/saner/StructureDefinition/AuditEventCreate", "http://hl7.org/fhir/uv/saner/StructureDefinition/AuditEventDelete", "http://hl7.org/fhir/uv/saner/StructureDefinition/AuditEventRead", "http://hl7.org/fhir/uv/saner/StructureDefinition/AuditEventSearch", "http://hl7.org/fhir/uv/saner/StructureDefinition/AuditEventUpdate", "http://test.com/fhir/structuredefinition/test-parent" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "AuditEvent:agent", "AuditEvent:entity", "AuditEvent:patient", "AuditEvent:source" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-date",
"type": "date",
"documentation": "Time when the event was recorded"
}, {
"name": "entity-type",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-entity-type",
"type": "token",
"documentation": "Type of entity involved"
}, {
"name": "agent",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-agent",
"type": "reference",
"documentation": "Identifier of who"
}, {
"name": "entity-role",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-entity-role",
"type": "token",
"documentation": "What role the entity played"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-source",
"type": "reference",
"documentation": "The identity of source detecting the event"
}, {
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-type",
"type": "token",
"documentation": "Type/identifier of event"
}, {
"name": "altid",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-altid",
"type": "token",
"documentation": "Alternative User identity"
}, {
"name": "agent-name",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-agent-name",
"type": "string",
"documentation": "Human friendly name for the agent"
}, {
"name": "entity-name",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-entity-name",
"type": "string",
"documentation": "Descriptor for entity"
}, {
"name": "subtype",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-subtype",
"type": "token",
"documentation": "More specific type/id for the event"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-patient",
"type": "reference",
"documentation": "Identifier of who"
}, {
"name": "action",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-action",
"type": "token",
"documentation": "Type of action performed during the event"
}, {
"name": "outcome",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-outcome",
"type": "token",
"documentation": "Whether the event succeeded or failed"
}, {
"name": "policy",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-policy",
"type": "uri",
"documentation": "Policy that authorized event"
}, {
"name": "address",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-address",
"type": "string",
"documentation": "Identifier for the network access point of the user device"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "site",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-site",
"type": "token",
"documentation": "Logical source location within the enterprise"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "agent-role",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-agent-role",
"type": "token",
"documentation": "Agent role in the event"
}, {
"name": "entity",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-entity",
"type": "reference",
"documentation": "Specific instance of resource"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 1460
} ],
"type": "Basic",
"profile": "http://hl7.org/fhir/StructureDefinition/Basic",
"supportedProfile": [ "https://who-int.github.io/svc/refs/heads/rc2/StructureDefinition/SVC-Basic-QRCode" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "Basic:author", "Basic:patient", "Basic:subject" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Basic-identifier",
"type": "token",
"documentation": "Business identifier"
}, {
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/Basic-code",
"type": "token",
"documentation": "Kind of Resource"
}, {
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/Basic-author",
"type": "reference",
"documentation": "Who created"
}, {
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/Basic-created",
"type": "date",
"documentation": "When created"
}, {
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Basic-subject",
"type": "reference",
"documentation": "Identifies the focus of this resource"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/Basic-patient",
"type": "reference",
"documentation": "Identifies the focus of this resource"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 35075
} ],
"type": "Binary",
"profile": "http://hl7.org/fhir/StructureDefinition/Binary",
"supportedProfile": [ "http://fhir.gevko.de/fhir/StructureDefinition/EVoBinary", "https://who-int.github.io/svc/refs/heads/rc2/StructureDefinition/DDCCBinaryQR", "https://who-int.github.io/svc/refs/heads/rc2/StructureDefinition/DDCCBinaryQRContent", "https://who-int.github.io/svc/refs/heads/rc2/StructureDefinition/DDCCBinaryQRPNG", "https://who-int.github.io/svc/refs/heads/rc2/StructureDefinition/shc-binary-qr", "https://who-int.github.io/svc/refs/heads/rc2/StructureDefinition/shc-binary-qrcontent", "https://who-int.github.io/svc/refs/heads/rc2/StructureDefinition/shc-binary-qrpng" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 71
} ],
"type": "BiologicallyDerivedProduct",
"profile": "http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProduct",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 1234
} ],
"type": "BodyStructure",
"profile": "http://hl7.org/fhir/StructureDefinition/BodyStructure",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "BodyStructure:patient" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/BodyStructure-identifier",
"type": "token",
"documentation": "Bodystructure identifier"
}, {
"name": "morphology",
"definition": "http://hl7.org/fhir/SearchParameter/BodyStructure-morphology",
"type": "token",
"documentation": "Kind of Structure"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/BodyStructure-patient",
"type": "reference",
"documentation": "Who this is about"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/BodyStructure-location",
"type": "token",
"documentation": "Body site"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 11299
} ],
"type": "Bundle",
"profile": "http://hl7.org/fhir/StructureDefinition/Bundle",
"supportedProfile": [ "http://fhir.gevko.de/fhir/StructureDefinition/EVoBundle", "http://fkcfhir.org/fhir/StructureDefinition/RequestBundle", "http://hl7.eu/fhir/ig/dgc/StructureDefinition/Bundle-dgc", "http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/library-bundle-cqfm", "http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/measure-bundle-cqfm", "http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/testcase-bundle-cqfm", "http://hl7.org/fhir/us/dme-orders/StructureDefinition/PAO-bundle4", "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-notification", "http://trilliumbridge.eu/fhir/StructureDefinition/bundle-ips-uv-trillium2", "https://ghit42796.github.io/fhir_test/StructureDefinition-Vaccine-Certificate-Bundle", "https://who-int.github.io/svc/refs/heads/rc2/StructureDefinition/DDCCBundle", "https://who-int.github.io/svc/refs/heads/rc2/StructureDefinition/shc-bundle", "https://who-int.github.io/svc/refs/heads/rc2/StructureDefinition/shc-submit-health-event-request", "https://who-int.github.io/svc/refs/heads/rc2/StructureDefinition/shc-submit-health-event-response" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "Bundle:composition", "Bundle:message" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Bundle-identifier",
"type": "token",
"documentation": "Persistent identifier for the bundle"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "message",
"definition": "http://hl7.org/fhir/SearchParameter/Bundle-message",
"type": "reference",
"documentation": "The first resource in the bundle, if the bundle type is \"message\" - this is a message header, and this parameter provides access to search its contents"
}, {
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/Bundle-type",
"type": "token",
"documentation": "document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "composition",
"definition": "http://hl7.org/fhir/SearchParameter/Bundle-composition",
"type": "reference",
"documentation": "The first resource in the bundle, if the bundle type is \"document\" - this is a composition, and this parameter provides access to search its contents"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "timestamp",
"definition": "http://hl7.org/fhir/SearchParameter/Bundle-timestamp",
"type": "date",
"documentation": "When the bundle was assembled"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 200
} ],
"type": "CapabilityStatement",
"profile": "http://hl7.org/fhir/StructureDefinition/CapabilityStatement",
"supportedProfile": [ "http://hl7.org/fhir/uv/saner/StructureDefinition/CapabilityStatementWithSlices" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "CapabilityStatement:guide", "CapabilityStatement:resource-profile", "CapabilityStatement:supported-profile" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-date",
"type": "date",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n"
}, {
"name": "software",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-software",
"type": "string",
"documentation": "Part of the name of a software application"
}, {
"name": "context-type-value",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context-type-value",
"type": "composite",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-jurisdiction",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n"
}, {
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-description",
"type": "string",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n"
}, {
"name": "context-type",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context-type",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n"
}, {
"name": "fhirversion",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-fhirversion",
"type": "token",
"documentation": "The version of FHIR"
}, {
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-title",
"type": "string",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html): The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html): The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): The human-friendly name of the value set\r\n"
}, {
"name": "mode",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-mode",
"type": "token",
"documentation": "Mode - restful (server/client) or messaging (sender/receiver)"
}, {
"name": "context-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context-quantity",
"type": "quantity",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n"
}, {
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n"
}, {
"name": "guide",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-guide",
"type": "reference",
"documentation": "Implementation guides supported"
}, {
"name": "context-type-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity",
"type": "composite",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n"
}, {
"name": "resource-profile",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-resource-profile",
"type": "reference",
"documentation": "A profile id invoked in a capability statement"
}, {
"name": "resource",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-resource",
"type": "token",
"documentation": "Name of a resource mentioned in a capability statement"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "format",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-format",
"type": "token",
"documentation": "formats supported (xml | json | ttl | mime type)"
}, {
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-version",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n"
}, {
"name": "supported-profile",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-supported-profile",
"type": "reference",
"documentation": "Profiles for use cases supported"
}, {
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-url",
"type": "uri",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "security-service",
"definition": "http://hl7.org/fhir/SearchParameter/CapabilityStatement-security-service",
"type": "token",
"documentation": "OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-name",
"type": "string",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n"
}, {
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-publisher",
"type": "string",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-status",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 12196
} ],
"type": "CarePlan",
"profile": "http://hl7.org/fhir/StructureDefinition/CarePlan",
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "CarePlan:activity-reference", "CarePlan:based-on", "CarePlan:care-team", "CarePlan:condition", "CarePlan:encounter", "CarePlan:goal", "CarePlan:instantiates-canonical", "CarePlan:part-of", "CarePlan:patient", "CarePlan:performer", "CarePlan:replaces", "CarePlan:subject" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "CarePlan:based-on", "CarePlan:part-of", "CarePlan:replaces", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DiagnosticReport:based-on", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImagingStudy:basedon", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "Media:based-on", "MessageHeader:focus", "Observation:based-on", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Procedure:based-on", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:based-on", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "ServiceRequest:based-on", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name": "care-team",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-care-team",
"type": "reference",
"documentation": "Who's involved in plan?"
}, {
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-subject",
"type": "reference",
"documentation": "Who the care plan is for"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "part-of",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-part-of",
"type": "reference",
"documentation": "Part of referenced CarePlan"
}, {
"name": "based-on",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-based-on",
"type": "reference",
"documentation": "Fulfills CarePlan"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name": "activity-date",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-activity-date",
"type": "date",
"documentation": "Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x]"
}, {
"name": "instantiates-uri",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-instantiates-uri",
"type": "uri",
"documentation": "Instantiates external protocol or definition"
}, {
"name": "activity-code",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-activity-code",
"type": "token",
"documentation": "Detail type of activity"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name": "goal",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-goal",
"type": "reference",
"documentation": "Desired outcome of plan"
}, {
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-performer",
"type": "reference",
"documentation": "Matches if the practitioner is listed as a performer in any of the \"simple\" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)"
}, {
"name": "replaces",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-replaces",
"type": "reference",
"documentation": "CarePlan replaced by this CarePlan"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "instantiates-canonical",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-instantiates-canonical",
"type": "reference",
"documentation": "Instantiates FHIR protocol or definition"
}, {
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-encounter",
"type": "reference",
"documentation": "Encounter created as part of"
}, {
"name": "intent",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-intent",
"type": "token",
"documentation": "proposal | plan | order | option"
}, {
"name": "activity-reference",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-activity-reference",
"type": "reference",
"documentation": "Activity details defined in specific resource"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "condition",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-condition",
"type": "reference",
"documentation": "Health issues this plan addresses"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-category",
"type": "token",
"documentation": "Type of plan"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-status",
"type": "token",
"documentation": "draft | active | on-hold | revoked | completed | entered-in-error | unknown"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 9437
} ],
"type": "CareTeam",
"profile": "http://hl7.org/fhir/StructureDefinition/CareTeam",
"supportedProfile": [ "http://example.org/fhir/StructureDefinition/MyCareTeam", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "CareTeam:encounter", "CareTeam:participant", "CareTeam:patient", "CareTeam:subject" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "CarePlan:care-team", "CarePlan:performer", "CareTeam:participant", "ChargeItem:performer-actor", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "Communication:recipient", "CommunicationRequest:based-on", "CommunicationRequest:recipient", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:actor", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:performer", "DeviceRequest:prior-request", "DiagnosticReport:performer", "DiagnosticReport:results-interpreter", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImagingStudy:performer", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "Media:operator", "MedicationRequest:intended-performer", "MessageHeader:focus", "Observation:focus", "Observation:performer", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "ServiceRequest:performer", "Task:based-on", "Task:focus", "Task:owner", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/CareTeam-subject",
"type": "reference",
"documentation": "Who care team is for"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/CareTeam-encounter",
"type": "reference",
"documentation": "Encounter created as part of"
}, {
"name": "participant",
"definition": "http://hl7.org/fhir/SearchParameter/CareTeam-participant",
"type": "reference",
"documentation": "Who is involved"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/CareTeam-category",
"type": "token",
"documentation": "Type of team"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/CareTeam-status",
"type": "token",
"documentation": "proposed | active | suspended | inactive | entered-in-error"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 69
} ],
"type": "CatalogEntry",
"profile": "http://hl7.org/fhir/StructureDefinition/CatalogEntry",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 315
} ],
"type": "ChargeItem",
"profile": "http://hl7.org/fhir/StructureDefinition/ChargeItem",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "ChargeItem:account", "ChargeItem:context", "ChargeItem:enterer", "ChargeItem:patient", "ChargeItem:performer-actor", "ChargeItem:performing-organization", "ChargeItem:requesting-organization", "ChargeItem:service", "ChargeItem:subject" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "performing-organization",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-performing-organization",
"type": "reference",
"documentation": "Organization providing the charged service"
}, {
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-code",
"type": "token",
"documentation": "A code that identifies the charge, like a billing code"
}, {
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-subject",
"type": "reference",
"documentation": "Individual service was done for/to"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "occurrence",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-occurrence",
"type": "date",
"documentation": "When the charged service was applied"
}, {
"name": "entered-date",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-entered-date",
"type": "date",
"documentation": "Date the charge item was entered"
}, {
"name": "performer-function",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-performer-function",
"type": "token",
"documentation": "What type of performance was done"
}, {
"name": "factor-override",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-factor-override",
"type": "number",
"documentation": "Factor overriding the associated rules"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-patient",
"type": "reference",
"documentation": "Individual service was done for/to"
}, {
"name": "price-override",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-price-override",
"type": "quantity",
"documentation": "Price overriding the associated rules"
}, {
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-context",
"type": "reference",
"documentation": "Encounter / Episode associated with event"
}, {
"name": "enterer",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-enterer",
"type": "reference",
"documentation": "Individual who was entering"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-identifier",
"type": "token",
"documentation": "Business Identifier for item"
}, {
"name": "quantity",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-quantity",
"type": "quantity",
"documentation": "Quantity of which the charge item has been serviced"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "service",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-service",
"type": "reference",
"documentation": "Which rendered service is being charged?"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "performer-actor",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-performer-actor",
"type": "reference",
"documentation": "Individual who was performing"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "account",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-account",
"type": "reference",
"documentation": "Account to place this charge"
}, {
"name": "requesting-organization",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItem-requesting-organization",
"type": "reference",
"documentation": "Organization requesting the charged service"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 1134
} ],
"type": "ChargeItemDefinition",
"profile": "http://hl7.org/fhir/StructureDefinition/ChargeItemDefinition",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-date",
"type": "date",
"documentation": "The charge item definition publication date"
}, {
"name": "context-type-value",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-context-type-value",
"type": "composite",
"documentation": "A use context type and value assigned to the charge item definition"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the charge item definition"
}, {
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-description",
"type": "string",
"documentation": "The description of the charge item definition"
}, {
"name": "context-type",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-context-type",
"type": "token",
"documentation": "A type of use context assigned to the charge item definition"
}, {
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-title",
"type": "string",
"documentation": "The human-friendly name of the charge item definition"
}, {
"name": "context-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-context-quantity",
"type": "quantity",
"documentation": "A quantity- or range-valued use context assigned to the charge item definition"
}, {
"name": "effective",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-effective",
"type": "date",
"documentation": "The time during which the charge item definition is intended to be in use"
}, {
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-context",
"type": "token",
"documentation": "A use context assigned to the charge item definition"
}, {
"name": "context-type-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-context-type-quantity",
"type": "composite",
"documentation": "A use context type and quantity- or range-based value assigned to the charge item definition"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-identifier",
"type": "token",
"documentation": "External identifier for the charge item definition"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-version",
"type": "token",
"documentation": "The business version of the charge item definition"
}, {
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-url",
"type": "uri",
"documentation": "The uri that identifies the charge item definition"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-publisher",
"type": "string",
"documentation": "Name of the publisher of the charge item definition"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/ChargeItemDefinition-status",
"type": "token",
"documentation": "The current status of the charge item definition"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 142680
} ],
"type": "Claim",
"profile": "http://hl7.org/fhir/StructureDefinition/Claim",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "Claim:care-team", "Claim:detail-udi", "Claim:encounter", "Claim:enterer", "Claim:facility", "Claim:insurer", "Claim:item-udi", "Claim:patient", "Claim:payee", "Claim:procedure-udi", "Claim:provider", "Claim:subdetail-udi" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClaimResponse:request", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ExplanationOfBenefit:claim", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "care-team",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-care-team",
"type": "reference",
"documentation": "Member of the CareTeam"
}, {
"name": "use",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-use",
"type": "token",
"documentation": "The kind of financial resource"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "payee",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-payee",
"type": "reference",
"documentation": "The party receiving any payment for the Claim"
}, {
"name": "provider",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-provider",
"type": "reference",
"documentation": "Provider responsible for the Claim"
}, {
"name": "insurer",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-insurer",
"type": "reference",
"documentation": "The target payor/insurer for the Claim"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-patient",
"type": "reference",
"documentation": "Patient receiving the products or services"
}, {
"name": "detail-udi",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-detail-udi",
"type": "reference",
"documentation": "UDI associated with a line item, detail product or service"
}, {
"name": "enterer",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-enterer",
"type": "reference",
"documentation": "The party responsible for the entry of the Claim"
}, {
"name": "procedure-udi",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-procedure-udi",
"type": "reference",
"documentation": "UDI associated with a procedure"
}, {
"name": "item-udi",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-item-udi",
"type": "reference",
"documentation": "UDI associated with a line item product or service"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-identifier",
"type": "token",
"documentation": "The primary identifier of the financial resource"
}, {
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-created",
"type": "date",
"documentation": "The creation date for the Claim"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-encounter",
"type": "reference",
"documentation": "Encounters associated with a billed line item"
}, {
"name": "priority",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-priority",
"type": "token",
"documentation": "Processing priority requested"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "subdetail-udi",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-subdetail-udi",
"type": "reference",
"documentation": "UDI associated with a line item, detail, subdetail product or service"
}, {
"name": "facility",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-facility",
"type": "reference",
"documentation": "Facility where the products or services have been or will be provided"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Claim-status",
"type": "token",
"documentation": "The status of the Claim instance."
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 20476
} ],
"type": "ClaimResponse",
"profile": "http://hl7.org/fhir/StructureDefinition/ClaimResponse",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "ClaimResponse:insurer", "ClaimResponse:patient", "ClaimResponse:request", "ClaimResponse:requestor" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:insurance", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ClaimResponse-identifier",
"type": "token",
"documentation": "The identity of the ClaimResponse"
}, {
"name": "request",
"definition": "http://hl7.org/fhir/SearchParameter/ClaimResponse-request",
"type": "reference",
"documentation": "The claim reference"
}, {
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/ClaimResponse-created",
"type": "date",
"documentation": "The creation date"
}, {
"name": "use",
"definition": "http://hl7.org/fhir/SearchParameter/ClaimResponse-use",
"type": "token",
"documentation": "The type of claim"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "payment-date",
"definition": "http://hl7.org/fhir/SearchParameter/ClaimResponse-payment-date",
"type": "date",
"documentation": "The expected payment date"
}, {
"name": "requestor",
"definition": "http://hl7.org/fhir/SearchParameter/ClaimResponse-requestor",
"type": "reference",
"documentation": "The Provider of the claim"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "disposition",
"definition": "http://hl7.org/fhir/SearchParameter/ClaimResponse-disposition",
"type": "string",
"documentation": "The contents of the disposition message"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "insurer",
"definition": "http://hl7.org/fhir/SearchParameter/ClaimResponse-insurer",
"type": "reference",
"documentation": "The organization which generated this resource"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/ClaimResponse-patient",
"type": "reference",
"documentation": "The subject of care"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "outcome",
"definition": "http://hl7.org/fhir/SearchParameter/ClaimResponse-outcome",
"type": "token",
"documentation": "The processing outcome"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/ClaimResponse-status",
"type": "token",
"documentation": "The status of the ClaimResponse"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 736
} ],
"type": "ClinicalImpression",
"profile": "http://hl7.org/fhir/StructureDefinition/ClinicalImpression",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "ClinicalImpression:assessor", "ClinicalImpression:encounter", "ClinicalImpression:finding-ref", "ClinicalImpression:investigation", "ClinicalImpression:patient", "ClinicalImpression:previous", "ClinicalImpression:problem", "ClinicalImpression:subject", "ClinicalImpression:supporting-info" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:previous", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ClinicalImpression-identifier",
"type": "token",
"documentation": "Business identifier"
}, {
"name": "previous",
"definition": "http://hl7.org/fhir/SearchParameter/ClinicalImpression-previous",
"type": "reference",
"documentation": "Reference to last assessment"
}, {
"name": "finding-code",
"definition": "http://hl7.org/fhir/SearchParameter/ClinicalImpression-finding-code",
"type": "token",
"documentation": "What was found"
}, {
"name": "assessor",
"definition": "http://hl7.org/fhir/SearchParameter/ClinicalImpression-assessor",
"type": "reference",
"documentation": "The clinician performing the assessment"
}, {
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/ClinicalImpression-subject",
"type": "reference",
"documentation": "Patient or group assessed"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/ClinicalImpression-encounter",
"type": "reference",
"documentation": "Encounter created as part of"
}, {
"name": "finding-ref",
"definition": "http://hl7.org/fhir/SearchParameter/ClinicalImpression-finding-ref",
"type": "reference",
"documentation": "What was found"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "problem",
"definition": "http://hl7.org/fhir/SearchParameter/ClinicalImpression-problem",
"type": "reference",
"documentation": "Relevant impressions of patient state"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "supporting-info",
"definition": "http://hl7.org/fhir/SearchParameter/ClinicalImpression-supporting-info",
"type": "reference",
"documentation": "Information supporting the clinical impression"
}, {
"name": "investigation",
"definition": "http://hl7.org/fhir/SearchParameter/ClinicalImpression-investigation",
"type": "reference",
"documentation": "Record of a specific investigation"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/ClinicalImpression-status",
"type": "token",
"documentation": "in-progress | completed | entered-in-error"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 2862
} ],
"type": "CodeSystem",
"profile": "http://hl7.org/fhir/StructureDefinition/CodeSystem",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "CodeSystem:supplements" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "CodeSystem:supplements", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-date",
"type": "date",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n"
}, {
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/CodeSystem-code",
"type": "token",
"documentation": "A code defined in the code system"
}, {
"name": "context-type-value",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context-type-value",
"type": "composite",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-jurisdiction",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n"
}, {
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-description",
"type": "string",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n"
}, {
"name": "context-type",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context-type",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n"
}, {
"name": "language",
"definition": "http://hl7.org/fhir/SearchParameter/CodeSystem-language",
"type": "token",
"documentation": "A language in which a designation is provided"
}, {
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-title",
"type": "string",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html): The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html): The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): The human-friendly name of the value set\r\n"
}, {
"name": "context-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context-quantity",
"type": "quantity",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n"
}, {
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n"
}, {
"name": "context-type-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity",
"type": "composite",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-identifier",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html): External identifier for the code system\r\n* [ConceptMap](conceptmap.html): External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html): External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html): External identifier for the structure definition\r\n* [StructureMap](structuremap.html): External identifier for the structure map\r\n* [ValueSet](valueset.html): External identifier for the value set\r\n"
}, {
"name": "content-mode",
"definition": "http://hl7.org/fhir/SearchParameter/CodeSystem-content-mode",
"type": "token",
"documentation": "not-present | example | fragment | complete | supplement"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-version",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n"
}, {
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-url",
"type": "uri",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "supplements",
"definition": "http://hl7.org/fhir/SearchParameter/CodeSystem-supplements",
"type": "reference",
"documentation": "Find code system supplements for the referenced code system"
}, {
"name": "system",
"definition": "http://hl7.org/fhir/SearchParameter/CodeSystem-system",
"type": "uri",
"documentation": "The system for any codes defined by this code system (same as 'url')"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-name",
"type": "string",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n"
}, {
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-publisher",
"type": "string",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-status",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n"
} ],
"operation": [ {
"name": "upload-external-code-system",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/CodeSystem-t-upload-external-code-system"
}, {
"name": "apply-codesystem-delta-remove",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/CodeSystem-t-apply-codesystem-delta-remove"
}, {
"name": "apply-codesystem-delta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/CodeSystem-t-apply-codesystem-delta-add"
}, {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "validate-code",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/CodeSystemValueSet-it-validate-code"
}, {
"name": "subsumes",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/CodeSystem-t-subsumes"
}, {
"name": "lookup",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/CodeSystem-t-lookup"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 1791
} ],
"type": "Communication",
"profile": "http://hl7.org/fhir/StructureDefinition/Communication",
"supportedProfile": [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-message" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "Communication:based-on", "Communication:encounter", "Communication:instantiates-canonical", "Communication:part-of", "Communication:patient", "Communication:recipient", "Communication:sender", "Communication:subject" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-subject",
"type": "reference",
"documentation": "Focus of message"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "part-of",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-part-of",
"type": "reference",
"documentation": "Part of this action"
}, {
"name": "medium",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-medium",
"type": "token",
"documentation": "A channel of communication"
}, {
"name": "based-on",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-based-on",
"type": "reference",
"documentation": "Request fulfilled by this communication"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-patient",
"type": "reference",
"documentation": "Focus of message"
}, {
"name": "instantiates-uri",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-instantiates-uri",
"type": "uri",
"documentation": "Instantiates external protocol or definition"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-identifier",
"type": "token",
"documentation": "Unique identifier"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "instantiates-canonical",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-instantiates-canonical",
"type": "reference",
"documentation": "Instantiates FHIR protocol or definition"
}, {
"name": "received",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-received",
"type": "date",
"documentation": "When received"
}, {
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-encounter",
"type": "reference",
"documentation": "Encounter created as part of"
}, {
"name": "sent",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-sent",
"type": "date",
"documentation": "When sent"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "sender",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-sender",
"type": "reference",
"documentation": "Message sender"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "recipient",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-recipient",
"type": "reference",
"documentation": "Message recipient"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-category",
"type": "token",
"documentation": "Message category"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Communication-status",
"type": "token",
"documentation": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 937
} ],
"type": "CommunicationRequest",
"profile": "http://hl7.org/fhir/StructureDefinition/CommunicationRequest",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "CommunicationRequest:based-on", "CommunicationRequest:encounter", "CommunicationRequest:patient", "CommunicationRequest:recipient", "CommunicationRequest:replaces", "CommunicationRequest:requester", "CommunicationRequest:sender", "CommunicationRequest:subject" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "CarePlan:activity-reference", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "CommunicationRequest:replaces", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "authored",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-authored",
"type": "date",
"documentation": "When request transitioned to being actionable"
}, {
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-subject",
"type": "reference",
"documentation": "Focus of message"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "medium",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-medium",
"type": "token",
"documentation": "A channel of communication"
}, {
"name": "occurrence",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-occurrence",
"type": "date",
"documentation": "When scheduled"
}, {
"name": "group-identifier",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-group-identifier",
"type": "token",
"documentation": "Composite request this is part of"
}, {
"name": "based-on",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-based-on",
"type": "reference",
"documentation": "Fulfills plan or proposal"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-patient",
"type": "reference",
"documentation": "Focus of message"
}, {
"name": "requester",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-requester",
"type": "reference",
"documentation": "Who/what is requesting service"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-identifier",
"type": "token",
"documentation": "Unique identifier"
}, {
"name": "replaces",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-replaces",
"type": "reference",
"documentation": "Request(s) replaced by this request"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-encounter",
"type": "reference",
"documentation": "Encounter created as part of"
}, {
"name": "priority",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-priority",
"type": "token",
"documentation": "routine | urgent | asap | stat"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "sender",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-sender",
"type": "reference",
"documentation": "Message sender"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "recipient",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-recipient",
"type": "reference",
"documentation": "Message recipient"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-category",
"type": "token",
"documentation": "Message category"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/CommunicationRequest-status",
"type": "token",
"documentation": "draft | active | on-hold | revoked | completed | entered-in-error | unknown"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 78
} ],
"type": "CompartmentDefinition",
"profile": "http://hl7.org/fhir/StructureDefinition/CompartmentDefinition",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-date",
"type": "date",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n"
}, {
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/CompartmentDefinition-code",
"type": "token",
"documentation": "Patient | Encounter | RelatedPerson | Practitioner | Device"
}, {
"name": "context-type-value",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context-type-value",
"type": "composite",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n"
}, {
"name": "resource",
"definition": "http://hl7.org/fhir/SearchParameter/CompartmentDefinition-resource",
"type": "token",
"documentation": "Name of resource type"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-description",
"type": "string",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n"
}, {
"name": "context-type",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context-type",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n"
}, {
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-version",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n"
}, {
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-url",
"type": "uri",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "context-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context-quantity",
"type": "quantity",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n"
}, {
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-name",
"type": "string",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n"
}, {
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-publisher",
"type": "string",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "context-type-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity",
"type": "composite",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-status",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 938715
} ],
"type": "Composition",
"profile": "http://hl7.org/fhir/StructureDefinition/Composition",
"supportedProfile": [ "http://hl7.org/fhir/us/bfdr/StructureDefinition/Composition-jurisdiction-fetal-death-report", "http://hl7.org/fhir/us/bfdr/StructureDefinition/Composition-jurisdiction-live-birth-report", "http://hl7.org/fhir/us/bfdr/StructureDefinition/Composition-provider-live-birth-report", "http://hl7.org/fhir/uv/ips/StructureDefinition/Composition-uv-ips", "https://fhir.kbv.de/StructureDefinition/KBV_PR_EAU_Composition", "https://nrces.in/ndhm/fhir/r4/StructureDefinition/OPConsultRecord", "https://who-int.github.io/svc/refs/heads/rc2/StructureDefinition/shc-composition", "https://who-int.github.io/svc/refs/heads/rc2/StructureDefinition/shf-composition" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "Composition:attester", "Composition:author", "Composition:encounter", "Composition:entry", "Composition:patient", "Composition:related-ref", "Composition:subject" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "Bundle:composition", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:related-ref", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-subject",
"type": "reference",
"documentation": "Who and/or what the composition is about"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "confidentiality",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-confidentiality",
"type": "token",
"documentation": "As defined by affinity domain"
}, {
"name": "section",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-section",
"type": "token",
"documentation": "Classification of section (recommended)"
}, {
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n"
}, {
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-title",
"type": "string",
"documentation": "Human Readable name/title"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-context",
"type": "token",
"documentation": "Code(s) that apply to the event being documented"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name": "period",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-period",
"type": "date",
"documentation": "The period covered by the documentation"
}, {
"name": "related-id",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-related-id",
"type": "token",
"documentation": "Target of the relationship"
}, {
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-author",
"type": "reference",
"documentation": "Who and/or what authored the composition"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type": "reference",
"documentation": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n"
}, {
"name": "attester",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-attester",
"type": "reference",
"documentation": "Who attested the composition"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "entry",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-entry",
"type": "reference",
"documentation": "A reference to data that supports this section"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "related-ref",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-related-ref",
"type": "reference",
"documentation": "Target of the relationship"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-category",
"type": "token",
"documentation": "Categorization of Composition"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Composition-status",
"type": "token",
"documentation": "preliminary | final | amended | entered-in-error"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "document",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Composition-i-document"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 468
} ],
"type": "ConceptMap",
"profile": "http://hl7.org/fhir/StructureDefinition/ConceptMap",
"supportedProfile": [ "http://phr.kanta.fi/ConceptMap" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "ConceptMap:other", "ConceptMap:source", "ConceptMap:source-uri", "ConceptMap:target", "ConceptMap:target-uri" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "ConceptMap:other", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-date",
"type": "date",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n"
}, {
"name": "other",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-other",
"type": "reference",
"documentation": "canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped"
}, {
"name": "context-type-value",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context-type-value",
"type": "composite",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n"
}, {
"name": "dependson",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-dependson",
"type": "uri",
"documentation": "Reference to property mapping depends on"
}, {
"name": "target-system",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-target-system",
"type": "uri",
"documentation": "Target system that the concepts are to be mapped to"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-jurisdiction",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n"
}, {
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-description",
"type": "string",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n"
}, {
"name": "context-type",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context-type",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n"
}, {
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-source",
"type": "reference",
"documentation": "The source value set that contains the concepts that are being mapped"
}, {
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-title",
"type": "string",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html): The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html): The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): The human-friendly name of the value set\r\n"
}, {
"name": "context-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context-quantity",
"type": "quantity",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n"
}, {
"name": "source-uri",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-source-uri",
"type": "reference",
"documentation": "The source value set that contains the concepts that are being mapped"
}, {
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n"
}, {
"name": "context-type-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity",
"type": "composite",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n"
}, {
"name": "source-system",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-source-system",
"type": "uri",
"documentation": "Source system where concepts to be mapped are defined"
}, {
"name": "target-code",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-target-code",
"type": "token",
"documentation": "Code that identifies the target element"
}, {
"name": "target-uri",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-target-uri",
"type": "reference",
"documentation": "The target value set which provides context for the mappings"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-identifier",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html): External identifier for the code system\r\n* [ConceptMap](conceptmap.html): External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html): External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html): External identifier for the structure definition\r\n* [StructureMap](structuremap.html): External identifier for the structure map\r\n* [ValueSet](valueset.html): External identifier for the value set\r\n"
}, {
"name": "product",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-product",
"type": "uri",
"documentation": "Reference to property mapping depends on"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-version",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n"
}, {
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-url",
"type": "uri",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n"
}, {
"name": "target",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-target",
"type": "reference",
"documentation": "The target value set which provides context for the mappings"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "source-code",
"definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-source-code",
"type": "token",
"documentation": "Identifies element being mapped"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-name",
"type": "string",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n"
}, {
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-publisher",
"type": "string",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-status",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "translate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/ConceptMap-it-translate"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 92786
} ],
"type": "Condition",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition",
"supportedProfile": [ "http://fhirr4.kids-first.io/fhir/StructureDefinition/us-core-condition", "http://hl7.org/fhir/us/bfdr/StructureDefinition/Condition-fetal-presentation", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition", "http://hl7.org/fhir/uv/ips/StructureDefinition/Condition-uv-ips", "https://nrces.in/ndhm/fhir/r4/StructureDefinition/Condition" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "Condition:asserter", "Condition:encounter", "Condition:evidence-detail", "Condition:patient", "Condition:subject" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "AdverseEvent:resultingcondition", "Appointment:reason-reference", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "CarePlan:condition", "ClinicalImpression:finding-ref", "ClinicalImpression:problem", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "Encounter:diagnosis", "Encounter:reason-reference", "EpisodeOfCare:condition", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "Immunization:reason-reference", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Procedure:reason-reference", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "RiskAssessment:condition", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "onset-info",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-onset-info",
"type": "string",
"documentation": "Onsets as a string"
}, {
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n"
}, {
"name": "evidence",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-evidence",
"type": "token",
"documentation": "Manifestation/symptom"
}, {
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-subject",
"type": "reference",
"documentation": "Who has the condition?"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "verification-status",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-verification-status",
"type": "token",
"documentation": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error"
}, {
"name": "clinical-status",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-clinical-status",
"type": "token",
"documentation": "The clinical status of the condition"
}, {
"name": "onset-date",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-onset-date",
"type": "date",
"documentation": "Date related onsets (dateTime and Period)"
}, {
"name": "abatement-date",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-abatement-date",
"type": "date",
"documentation": "Date-related abatements (dateTime and period)"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name": "abatement-age",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-abatement-age",
"type": "quantity",
"documentation": "Abatement as age or age range"
}, {
"name": "evidence-detail",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-evidence-detail",
"type": "reference",
"documentation": "Supporting information found elsewhere"
}, {
"name": "severity",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-severity",
"type": "token",
"documentation": "The severity of the condition"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name": "recorded-date",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-recorded-date",
"type": "date",
"documentation": "Date record was first recorded"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-encounter",
"type": "reference",
"documentation": "Encounter created as part of"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "asserter",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-asserter",
"type": "reference",
"documentation": "Person who asserts this condition"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "stage",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-stage",
"type": "token",
"documentation": "Simple summary (disease specific)"
}, {
"name": "abatement-string",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-abatement-string",
"type": "string",
"documentation": "Abatement as a string"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "onset-age",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-onset-age",
"type": "quantity",
"documentation": "Onsets as age or age range"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "body-site",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-body-site",
"type": "token",
"documentation": "Anatomical location, if relevant"
}, {
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/Condition-category",
"type": "token",
"documentation": "The category of the condition"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 1204
} ],
"type": "Consent",
"profile": "http://hl7.org/fhir/StructureDefinition/Consent",
"supportedProfile": [ "https://fhir.gevko.de/StructureDefinition/PR_OSC_Consent_LE_TE" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "Consent:actor", "Consent:consentor", "Consent:data", "Consent:organization", "Consent:patient", "Consent:source-reference" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Consent:source-reference", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name": "data",
"definition": "http://hl7.org/fhir/SearchParameter/Consent-data",
"type": "reference",
"documentation": "The actual data reference"
}, {
"name": "purpose",
"definition": "http://hl7.org/fhir/SearchParameter/Consent-purpose",
"type": "token",
"documentation": "Context of activities covered by this rule"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "source-reference",
"definition": "http://hl7.org/fhir/SearchParameter/Consent-source-reference",
"type": "reference",
"documentation": "Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name": "scope",
"definition": "http://hl7.org/fhir/SearchParameter/Consent-scope",
"type": "token",
"documentation": "Which of the four areas this resource covers (extensible)"
}, {
"name": "action",
"definition": "http://hl7.org/fhir/SearchParameter/Consent-action",
"type": "token",
"documentation": "Actions controlled by this rule"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name": "period",
"definition": "http://hl7.org/fhir/SearchParameter/Consent-period",
"type": "date",
"documentation": "Timeframe for this rule"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "actor",
"definition": "http://hl7.org/fhir/SearchParameter/Consent-actor",
"type": "reference",
"documentation": "Resource for the actor (or group, by role)"
}, {
"name": "security-label",
"definition": "http://hl7.org/fhir/SearchParameter/Consent-security-label",
"type": "token",
"documentation": "Security Labels that define affected resources"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/Consent-organization",
"type": "reference",
"documentation": "Custodian of the consent"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "consentor",
"definition": "http://hl7.org/fhir/SearchParameter/Consent-consentor",
"type": "reference",
"documentation": "Who is agreeing to the policy and rules"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/Consent-category",
"type": "token",
"documentation": "Classification of the consent statement - for indexing/retrieval"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Consent-status",
"type": "token",
"documentation": "draft | proposed | active | rejected | inactive | entered-in-error"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 125
} ],
"type": "Contract",
"profile": "http://hl7.org/fhir/StructureDefinition/Contract",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "Contract:authority", "Contract:domain", "Contract:patient", "Contract:signer", "Contract:subject" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Consent:source-reference", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Contract-identifier",
"type": "token",
"documentation": "The identity of the contract"
}, {
"name": "instantiates",
"definition": "http://hl7.org/fhir/SearchParameter/Contract-instantiates",
"type": "uri",
"documentation": "A source definition of the contract"
}, {
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Contract-subject",
"type": "reference",
"documentation": "The identity of the subject of the contract"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/Contract-url",
"type": "uri",
"documentation": "The basal contract definition"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/Contract-patient",
"type": "reference",
"documentation": "The identity of the subject of the contract (if a patient)"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "authority",
"definition": "http://hl7.org/fhir/SearchParameter/Contract-authority",
"type": "reference",
"documentation": "The authority of the contract"
}, {
"name": "domain",
"definition": "http://hl7.org/fhir/SearchParameter/Contract-domain",
"type": "reference",
"documentation": "The domain of the contract"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "issued",
"definition": "http://hl7.org/fhir/SearchParameter/Contract-issued",
"type": "date",
"documentation": "The date/time the contract was issued"
}, {
"name": "signer",
"definition": "http://hl7.org/fhir/SearchParameter/Contract-signer",
"type": "reference",
"documentation": "Contract Signatory Party"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Contract-status",
"type": "token",
"documentation": "The status of the contract"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 29543
} ],
"type": "Coverage",
"profile": "http://hl7.org/fhir/StructureDefinition/Coverage",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "Coverage:beneficiary", "Coverage:patient", "Coverage:payor", "Coverage:policy-holder", "Coverage:subscriber" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:insurance", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ExplanationOfBenefit:coverage", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-identifier",
"type": "token",
"documentation": "The primary identifier of the insured and the coverage"
}, {
"name": "subscriber",
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-subscriber",
"type": "reference",
"documentation": "Reference to the subscriber"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-type",
"type": "token",
"documentation": "The kind of coverage (health plan, auto, Workers Compensation)"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "payor",
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-payor",
"type": "reference",
"documentation": "The identity of the insurer or party paying for services"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "beneficiary",
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-beneficiary",
"type": "reference",
"documentation": "Covered party"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-patient",
"type": "reference",
"documentation": "Retrieve coverages for a patient"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "class-value",
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-class-value",
"type": "string",
"documentation": "Value of the class (eg. Plan number, group number)"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "class-type",
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-class-type",
"type": "token",
"documentation": "Coverage class (eg. plan, group)"
}, {
"name": "dependent",
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-dependent",
"type": "string",
"documentation": "Dependent number"
}, {
"name": "policy-holder",
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-policy-holder",
"type": "reference",
"documentation": "Reference to the policyholder"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Coverage-status",
"type": "token",
"documentation": "The status of the Coverage"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 696
} ],
"type": "CoverageEligibilityRequest",
"profile": "http://hl7.org/fhir/StructureDefinition/CoverageEligibilityRequest",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "CoverageEligibilityRequest:enterer", "CoverageEligibilityRequest:facility", "CoverageEligibilityRequest:patient", "CoverageEligibilityRequest:provider" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "CoverageEligibilityResponse:request", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/CoverageEligibilityRequest-identifier",
"type": "token",
"documentation": "The business identifier of the Eligibility"
}, {
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/CoverageEligibilityRequest-created",
"type": "date",
"documentation": "The creation date for the EOB"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "provider",
"definition": "http://hl7.org/fhir/SearchParameter/CoverageEligibilityRequest-provider",
"type": "reference",
"documentation": "The reference to the provider"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/CoverageEligibilityRequest-patient",
"type": "reference",
"documentation": "The reference to the patient"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "enterer",
"definition": "http://hl7.org/fhir/SearchParameter/CoverageEligibilityRequest-enterer",
"type": "reference",
"documentation": "The party who is responsible for the request"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "facility",
"definition": "http://hl7.org/fhir/SearchParameter/CoverageEligibilityRequest-facility",
"type": "reference",
"documentation": "Facility responsible for the goods and services"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/CoverageEligibilityRequest-status",
"type": "token",
"documentation": "The status of the EligibilityRequest"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 98
} ],
"type": "CoverageEligibilityResponse",
"profile": "http://hl7.org/fhir/StructureDefinition/CoverageEligibilityResponse",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "CoverageEligibilityResponse:insurer", "CoverageEligibilityResponse:patient", "CoverageEligibilityResponse:request", "CoverageEligibilityResponse:requestor" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/CoverageEligibilityResponse-identifier",
"type": "token",
"documentation": "The business identifier"
}, {
"name": "request",
"definition": "http://hl7.org/fhir/SearchParameter/CoverageEligibilityResponse-request",
"type": "reference",
"documentation": "The EligibilityRequest reference"
}, {
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/CoverageEligibilityResponse-created",
"type": "date",
"documentation": "The creation date"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "requestor",
"definition": "http://hl7.org/fhir/SearchParameter/CoverageEligibilityResponse-requestor",
"type": "reference",
"documentation": "The EligibilityRequest provider"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "disposition",
"definition": "http://hl7.org/fhir/SearchParameter/CoverageEligibilityResponse-disposition",
"type": "string",
"documentation": "The contents of the disposition message"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "insurer",
"definition": "http://hl7.org/fhir/SearchParameter/CoverageEligibilityResponse-insurer",
"type": "reference",
"documentation": "The organization which generated this resource"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/CoverageEligibilityResponse-patient",
"type": "reference",
"documentation": "The reference to the patient"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "outcome",
"definition": "http://hl7.org/fhir/SearchParameter/CoverageEligibilityResponse-outcome",
"type": "token",
"documentation": "The processing outcome"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/CoverageEligibilityResponse-status",
"type": "token",
"documentation": "The EligibilityRequest status"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 459
} ],
"type": "DetectedIssue",
"profile": "http://hl7.org/fhir/StructureDefinition/DetectedIssue",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "DetectedIssue:author", "DetectedIssue:implicated", "DetectedIssue:patient" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/DetectedIssue-code",
"type": "token",
"documentation": "Issue Category, e.g. drug-drug, duplicate therapy, etc."
}, {
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/DetectedIssue-author",
"type": "reference",
"documentation": "The provider or device that identified the issue"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "identified",
"definition": "http://hl7.org/fhir/SearchParameter/DetectedIssue-identified",
"type": "date",
"documentation": "When identified"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "implicated",
"definition": "http://hl7.org/fhir/SearchParameter/DetectedIssue-implicated",
"type": "reference",
"documentation": "Problem resource"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 16498
} ],
"type": "Device",
"profile": "http://hl7.org/fhir/StructureDefinition/Device",
"supportedProfile": [ "http://example.org/fhir/dossi/StructureDefinition/dossi-device", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device", "http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/device-softwaresystem-cqfm", "http://hl7.org/fhir/uv/ips/StructureDefinition/Device-observer-uv-ips", "http://hl7.org/fhir/uv/ips/StructureDefinition/Device-uv-ips" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "Device:location", "Device:organization", "Device:patient" ],
"searchRevInclude": [ "Account:subject", "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "AdverseEvent:substance", "Appointment:actor", "Appointment:supporting-info", "AppointmentResponse:actor", "AuditEvent:agent", "AuditEvent:entity", "AuditEvent:source", "Basic:subject", "CarePlan:performer", "ChargeItem:enterer", "ChargeItem:performer-actor", "Claim:detail-udi", "Claim:item-udi", "Claim:procedure-udi", "Claim:subdetail-udi", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "Communication:recipient", "Communication:sender", "CommunicationRequest:based-on", "CommunicationRequest:recipient", "CommunicationRequest:requester", "CommunicationRequest:sender", "Composition:author", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:actor", "Consent:data", "Contract:subject", "DetectedIssue:author", "DetectedIssue:implicated", "DeviceMetric:parent", "DeviceMetric:source", "DeviceRequest:based-on", "DeviceRequest:device", "DeviceRequest:performer", "DeviceRequest:prior-request", "DeviceRequest:requester", "DeviceRequest:subject", "DeviceUseStatement:device", "DiagnosticReport:subject", "DocumentManifest:author", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentManifest:subject", "DocumentReference:author", "DocumentReference:related", "DocumentReference:subject", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ExplanationOfBenefit:detail-udi", "ExplanationOfBenefit:item-udi", "ExplanationOfBenefit:procedure-udi", "ExplanationOfBenefit:subdetail-udi", "Flag:author", "Group:member", "ImagingStudy:performer", "ImagingStudy:subject", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Invoice:participant", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "List:source", "List:subject", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MeasureReport:subject", "Media:device", "Media:operator", "Media:subject", "MedicationAdministration:device", "MedicationAdministration:performer", "MedicationDispense:performer", "MedicationRequest:intended-performer", "MedicationRequest:requester", "MessageHeader:focus", "MessageHeader:target", "Observation:device", "Observation:focus", "Observation:subject", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Procedure:performer", "Provenance:agent", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:author", "QuestionnaireResponse:subject", "RequestGroup:author", "RequestGroup:instantiates-canonical", "RequestGroup:participant", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "RiskAssessment:performer", "Schedule:actor", "ServiceRequest:performer", "ServiceRequest:requester", "ServiceRequest:subject", "Specimen:subject", "SupplyRequest:requester", "Task:based-on", "Task:focus", "Task:owner", "Task:requester", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "udi-di",
"definition": "http://hl7.org/fhir/SearchParameter/Device-udi-di",
"type": "string",
"documentation": "The udi Device Identifier (DI)"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Device-identifier",
"type": "token",
"documentation": "Instance id from manufacturer, owner, and others"
}, {
"name": "udi-carrier",
"definition": "http://hl7.org/fhir/SearchParameter/Device-udi-carrier",
"type": "string",
"documentation": "UDI Barcode (RFID or other technology) string in *HRF* format."
}, {
"name": "device-name",
"definition": "http://hl7.org/fhir/SearchParameter/Device-device-name",
"type": "string",
"documentation": "A server defined search that may match any of the string fields in Device.deviceName or Device.type."
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/Device-type",
"type": "token",
"documentation": "The type of the device"
}, {
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/Device-url",
"type": "uri",
"documentation": "Network address to contact device"
}, {
"name": "manufacturer",
"definition": "http://hl7.org/fhir/SearchParameter/Device-manufacturer",
"type": "string",
"documentation": "The manufacturer of the device"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/Device-patient",
"type": "reference",
"documentation": "Patient information, if the resource is affixed to a person"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/Device-organization",
"type": "reference",
"documentation": "The organization responsible for the device"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/Device-location",
"type": "reference",
"documentation": "A location, where the resource is found"
}, {
"name": "model",
"definition": "http://hl7.org/fhir/SearchParameter/Device-model",
"type": "string",
"documentation": "The model of the device"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Device-status",
"type": "token",
"documentation": "active | inactive | entered-in-error | unknown"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 89
} ],
"type": "DeviceDefinition",
"profile": "http://hl7.org/fhir/StructureDefinition/DeviceDefinition",
"supportedProfile": [ "http://example.org/fhir/dossi/StructureDefinition/dossi-devicedefinition" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "DeviceDefinition:parent" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceDefinition:parent", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceDefinition-identifier",
"type": "token",
"documentation": "The identifier of the component"
}, {
"name": "parent",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceDefinition-parent",
"type": "reference",
"documentation": "The parent DeviceDefinition resource"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceDefinition-type",
"type": "token",
"documentation": "The device component type"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 250
} ],
"type": "DeviceMetric",
"profile": "http://hl7.org/fhir/StructureDefinition/DeviceMetric",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "DeviceMetric:parent", "DeviceMetric:source" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "Media:device", "MessageHeader:focus", "Observation:device", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceMetric-identifier",
"type": "token",
"documentation": "The identifier of the metric"
}, {
"name": "parent",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceMetric-parent",
"type": "reference",
"documentation": "The parent DeviceMetric resource"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceMetric-source",
"type": "reference",
"documentation": "The device resource"
}, {
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceMetric-type",
"type": "token",
"documentation": "The component type"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceMetric-category",
"type": "token",
"documentation": "The category of the metric"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 2840
} ],
"type": "DeviceRequest",
"profile": "http://hl7.org/fhir/StructureDefinition/DeviceRequest",
"supportedProfile": [ "http://example.org/fhir/dossi/StructureDefinition/dossi-devicerequest" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "DeviceRequest:based-on", "DeviceRequest:device", "DeviceRequest:encounter", "DeviceRequest:instantiates-canonical", "DeviceRequest:insurance", "DeviceRequest:patient", "DeviceRequest:performer", "DeviceRequest:prior-request", "DeviceRequest:requester", "DeviceRequest:subject" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "CarePlan:activity-reference", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:based-on", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "insurance",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-insurance",
"type": "reference",
"documentation": "Associated insurance coverage"
}, {
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n"
}, {
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-subject",
"type": "reference",
"documentation": "Individual the service is ordered for"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "group-identifier",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-group-identifier",
"type": "token",
"documentation": "Composite request this is part of"
}, {
"name": "based-on",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-based-on",
"type": "reference",
"documentation": "Plan/proposal/order fulfilled by this request"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name": "instantiates-uri",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-instantiates-uri",
"type": "uri",
"documentation": "Instantiates external protocol or definition"
}, {
"name": "requester",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-requester",
"type": "reference",
"documentation": "Who/what is requesting service"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-performer",
"type": "reference",
"documentation": "Desired performer for service"
}, {
"name": "event-date",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-event-date",
"type": "date",
"documentation": "When service should occur"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "instantiates-canonical",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-instantiates-canonical",
"type": "reference",
"documentation": "Instantiates FHIR protocol or definition"
}, {
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type": "reference",
"documentation": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n"
}, {
"name": "authored-on",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-authored-on",
"type": "date",
"documentation": "When the request transitioned to being actionable"
}, {
"name": "intent",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-intent",
"type": "token",
"documentation": "proposal | plan | original-order |reflex-order"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "device",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-device",
"type": "reference",
"documentation": "Reference to resource that is being requested/ordered"
}, {
"name": "prior-request",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-prior-request",
"type": "reference",
"documentation": "Request takes the place of referenced completed or terminated requests"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceRequest-status",
"type": "token",
"documentation": "entered-in-error | draft | active |suspended | completed"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 244
} ],
"type": "DeviceUseStatement",
"profile": "http://hl7.org/fhir/StructureDefinition/DeviceUseStatement",
"supportedProfile": [ "http://example.org/fhir/dossi/StructureDefinition/dossi-deviceusestatement", "http://hl7.org/fhir/uv/ips/StructureDefinition/DeviceUseStatement-uv-ips" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "DeviceUseStatement:device", "DeviceUseStatement:patient", "DeviceUseStatement:subject" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceUseStatement-identifier",
"type": "token",
"documentation": "Search by identifier"
}, {
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceUseStatement-subject",
"type": "reference",
"documentation": "Search by subject"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "device",
"definition": "http://hl7.org/fhir/SearchParameter/DeviceUseStatement-device",
"type": "reference",
"documentation": "Search by device"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 62388
} ],
"type": "DiagnosticReport",
"profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note", "http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/genomics-report", "http://hl7.org/fhir/uv/ips/StructureDefinition/DiagnosticReport-uv-ips" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "DiagnosticReport:based-on", "DiagnosticReport:encounter", "DiagnosticReport:media", "DiagnosticReport:patient", "DiagnosticReport:performer", "DiagnosticReport:result", "DiagnosticReport:results-interpreter", "DiagnosticReport:specimen", "DiagnosticReport:subject" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ChargeItem:service", "ClinicalImpression:investigation", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "Immunization:reason-reference", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Procedure:reason-reference", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n"
}, {
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-subject",
"type": "reference",
"documentation": "The subject of the report"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "media",
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-media",
"type": "reference",
"documentation": "A reference to the image source."
}, {
"name": "conclusion",
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-conclusion",
"type": "token",
"documentation": "A coded conclusion (interpretation/impression) on the report"
}, {
"name": "result",
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-result",
"type": "reference",
"documentation": "Link to an atomic result (observation resource)"
}, {
"name": "based-on",
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-based-on",
"type": "reference",
"documentation": "Reference to the service request."
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name": "specimen",
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-specimen",
"type": "reference",
"documentation": "The specimen details"
}, {
"name": "issued",
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-issued",
"type": "date",
"documentation": "When the report was issued"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-performer",
"type": "reference",
"documentation": "Who is responsible for the report"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type": "reference",
"documentation": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-category",
"type": "token",
"documentation": "Which diagnostic discipline/department created the report"
}, {
"name": "results-interpreter",
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-results-interpreter",
"type": "reference",
"documentation": "Who was the source of the report"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-status",
"type": "token",
"documentation": "The status of the report"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 544
} ],
"type": "DocumentManifest",
"profile": "http://hl7.org/fhir/StructureDefinition/DocumentManifest",
"supportedProfile": [ "http://fhir.gevko.de/fhir/StructureDefinition/EVoDocumentManifest" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "DocumentManifest:author", "DocumentManifest:item", "DocumentManifest:patient", "DocumentManifest:recipient", "DocumentManifest:related-ref", "DocumentManifest:subject" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name": "item",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentManifest-item",
"type": "reference",
"documentation": "Items in manifest"
}, {
"name": "related-id",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentManifest-related-id",
"type": "token",
"documentation": "Identifiers of things that are related"
}, {
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentManifest-author",
"type": "reference",
"documentation": "Who and/or what authored the DocumentManifest"
}, {
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentManifest-created",
"type": "date",
"documentation": "When this document manifest created"
}, {
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentManifest-subject",
"type": "reference",
"documentation": "The subject of the set of documents"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentManifest-description",
"type": "string",
"documentation": "Human-readable description (title)"
}, {
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentManifest-source",
"type": "uri",
"documentation": "The source system/application/software"
}, {
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "related-ref",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentManifest-related-ref",
"type": "reference",
"documentation": "Related Resource"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "recipient",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentManifest-recipient",
"type": "reference",
"documentation": "Intended to get notified about this set of documents"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentManifest-status",
"type": "token",
"documentation": "current | superseded | entered-in-error"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 35572
} ],
"type": "DocumentReference",
"profile": "http://hl7.org/fhir/StructureDefinition/DocumentReference",
"supportedProfile": [ "http://fhir.gevko.de/fhir/StructureDefinition/EVoDocumentReference", "http://gev.de/fhir/StructureDefinition/RepoDocumentReference", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "DocumentReference:authenticator", "DocumentReference:author", "DocumentReference:custodian", "DocumentReference:encounter", "DocumentReference:patient", "DocumentReference:related", "DocumentReference:relatesto", "DocumentReference:subject" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Consent:source-reference", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "DocumentReference:relatesto", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MedicationKnowledge:monograph", "MessageHeader:focus", "Observation:derived-from", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Procedure:reason-reference", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-date",
"type": "date",
"documentation": "When this document reference was created"
}, {
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-subject",
"type": "reference",
"documentation": "Who/what is the subject of the document"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-description",
"type": "string",
"documentation": "Human-readable description"
}, {
"name": "language",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-language",
"type": "token",
"documentation": "Human language of the content (BCP-47)"
}, {
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n"
}, {
"name": "relation",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-relation",
"type": "token",
"documentation": "replaces | transforms | signs | appends"
}, {
"name": "setting",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-setting",
"type": "token",
"documentation": "Additional details about where the content was created (e.g. clinical specialty)"
}, {
"name": "related",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-related",
"type": "reference",
"documentation": "Related identifiers or resources"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name": "event",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-event",
"type": "token",
"documentation": "Main clinical acts documented"
}, {
"name": "relationship",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-relationship",
"type": "composite",
"documentation": "Combination of relation and relatesTo"
}, {
"name": "authenticator",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-authenticator",
"type": "reference",
"documentation": "Who/what authenticated the document"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name": "period",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-period",
"type": "date",
"documentation": "Time of service that is being documented"
}, {
"name": "custodian",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-custodian",
"type": "reference",
"documentation": "Organization which maintains the document"
}, {
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-author",
"type": "reference",
"documentation": "Who and/or what authored the document"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "format",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-format",
"type": "token",
"documentation": "Format/content rules for the document"
}, {
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type": "reference",
"documentation": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n"
}, {
"name": "contenttype",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-contenttype",
"type": "token",
"documentation": "Mime type of the content, with charset etc."
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "security-label",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-security-label",
"type": "token",
"documentation": "Document security-tags"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-location",
"type": "uri",
"documentation": "Uri where the data can be found"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-category",
"type": "token",
"documentation": "Categorization of document"
}, {
"name": "relatesto",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-relatesto",
"type": "reference",
"documentation": "Target of the relationship"
}, {
"name": "facility",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-facility",
"type": "token",
"documentation": "Kind of facility where patient was seen"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-status",
"type": "token",
"documentation": "current | superseded | entered-in-error"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 68
} ],
"type": "EffectEvidenceSynthesis",
"profile": "http://hl7.org/fhir/StructureDefinition/EffectEvidenceSynthesis",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-date",
"type": "date",
"documentation": "The effect evidence synthesis publication date"
}, {
"name": "context-type-value",
"definition": "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-context-type-value",
"type": "composite",
"documentation": "A use context type and value assigned to the effect evidence synthesis"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the effect evidence synthesis"
}, {
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-description",
"type": "string",
"documentation": "The description of the effect evidence synthesis"
}, {
"name": "context-type",
"definition": "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-context-type",
"type": "token",
"documentation": "A type of use context assigned to the effect evidence synthesis"
}, {
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-title",
"type": "string",
"documentation": "The human-friendly name of the effect evidence synthesis"
}, {
"name": "context-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-context-quantity",
"type": "quantity",
"documentation": "A quantity- or range-valued use context assigned to the effect evidence synthesis"
}, {
"name": "effective",
"definition": "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-effective",
"type": "date",
"documentation": "The time during which the effect evidence synthesis is intended to be in use"
}, {
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-context",
"type": "token",
"documentation": "A use context assigned to the effect evidence synthesis"
}, {
"name": "context-type-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-context-type-quantity",
"type": "composite",
"documentation": "A use context type and quantity- or range-based value assigned to the effect evidence synthesis"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-identifier",
"type": "token",
"documentation": "External identifier for the effect evidence synthesis"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-version",
"type": "token",
"documentation": "The business version of the effect evidence synthesis"
}, {
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-url",
"type": "uri",
"documentation": "The uri that identifies the effect evidence synthesis"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-name",
"type": "string",
"documentation": "Computationally friendly name of the effect evidence synthesis"
}, {
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-publisher",
"type": "string",
"documentation": "Name of the publisher of the effect evidence synthesis"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/EffectEvidenceSynthesis-status",
"type": "token",
"documentation": "The current status of the effect evidence synthesis"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 191045
} ],
"type": "Encounter",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter",
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "Encounter:account", "Encounter:appointment", "Encounter:based-on", "Encounter:diagnosis", "Encounter:episode-of-care", "Encounter:location", "Encounter:part-of", "Encounter:participant", "Encounter:patient", "Encounter:practitioner", "Encounter:reason-reference", "Encounter:service-provider", "Encounter:subject" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "CarePlan:encounter", "CareTeam:encounter", "ChargeItem:context", "Claim:encounter", "ClinicalImpression:encounter", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:encounter", "Communication:part-of", "CommunicationRequest:based-on", "CommunicationRequest:encounter", "Composition:encounter", "Composition:entry", "Composition:subject", "Condition:encounter", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:encounter", "DeviceRequest:prior-request", "DiagnosticReport:encounter", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:encounter", "DocumentReference:related", "Encounter:part-of", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ExplanationOfBenefit:encounter", "Flag:encounter", "ImagingStudy:encounter", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:encounter", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "Media:encounter", "MedicationAdministration:context", "MedicationDispense:context", "MedicationRequest:encounter", "MedicationStatement:context", "MessageHeader:focus", "NutritionOrder:encounter", "Observation:encounter", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Procedure:encounter", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:encounter", "QuestionnaireResponse:subject", "RequestGroup:encounter", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "RiskAssessment:encounter", "ServiceRequest:encounter", "Task:based-on", "Task:encounter", "Task:focus", "Task:subject", "VerificationResult:target", "VisionPrescription:encounter" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name": "participant-type",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-participant-type",
"type": "token",
"documentation": "Role of participant in encounter"
}, {
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-subject",
"type": "reference",
"documentation": "The patient or group present at the encounter"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "appointment",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-appointment",
"type": "reference",
"documentation": "The appointment that scheduled this encounter"
}, {
"name": "part-of",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-part-of",
"type": "reference",
"documentation": "Another Encounter this encounter is part of"
}, {
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n"
}, {
"name": "participant",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-participant",
"type": "reference",
"documentation": "Persons involved in the encounter other than the patient"
}, {
"name": "reason-code",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-reason-code",
"type": "token",
"documentation": "Coded reason the encounter takes place"
}, {
"name": "based-on",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-based-on",
"type": "reference",
"documentation": "The ServiceRequest that initiated this encounter"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name": "location-period",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-location-period",
"type": "date",
"documentation": "Time period during which the patient was present at the location"
}, {
"name": "special-arrangement",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-special-arrangement",
"type": "token",
"documentation": "Wheelchair, translator, stretcher, etc."
}, {
"name": "class",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-class",
"type": "token",
"documentation": "Classification of patient encounter"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name": "practitioner",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-practitioner",
"type": "reference",
"documentation": "Persons involved in the encounter other than the patient"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "episode-of-care",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-episode-of-care",
"type": "reference",
"documentation": "Episode(s) of care that this encounter should be recorded against"
}, {
"name": "length",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-length",
"type": "quantity",
"documentation": "Length of encounter in days"
}, {
"name": "diagnosis",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-diagnosis",
"type": "reference",
"documentation": "The diagnosis or procedure relevant to the encounter"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "reason-reference",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-reason-reference",
"type": "reference",
"documentation": "Reason the encounter takes place (reference)"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-location",
"type": "reference",
"documentation": "Location the encounter takes place"
}, {
"name": "service-provider",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-service-provider",
"type": "reference",
"documentation": "The organization (facility) responsible for this encounter"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "account",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-account",
"type": "reference",
"documentation": "The set of accounts that may be used for billing for this Encounter"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-status",
"type": "token",
"documentation": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "everything",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/EncounterPatient-it-everything"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 2502
} ],
"type": "Endpoint",
"profile": "http://hl7.org/fhir/StructureDefinition/Endpoint",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "Endpoint:organization" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "HealthcareService:endpoint", "ImagingStudy:endpoint", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "InsurancePlan:endpoint", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Location:endpoint", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "Organization:endpoint", "OrganizationAffiliation:endpoint", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "PractitionerRole:endpoint", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Endpoint-identifier",
"type": "token",
"documentation": "Identifies this endpoint across multiple systems"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "payload-type",
"definition": "http://hl7.org/fhir/SearchParameter/Endpoint-payload-type",
"type": "token",
"documentation": "The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "connection-type",
"definition": "http://hl7.org/fhir/SearchParameter/Endpoint-connection-type",
"type": "token",
"documentation": "Protocol/Profile/Standard to be used with this endpoint connection"
}, {
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/Endpoint-organization",
"type": "reference",
"documentation": "The organization that is managing the endpoint"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/Endpoint-name",
"type": "string",
"documentation": "A name that this endpoint can be identified by"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Endpoint-status",
"type": "token",
"documentation": "The current status of the Endpoint (usually expected to be active)"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 149
} ],
"type": "EnrollmentRequest",
"profile": "http://hl7.org/fhir/StructureDefinition/EnrollmentRequest",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "EnrollmentRequest:patient", "EnrollmentRequest:subject" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EnrollmentResponse:request", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/EnrollmentRequest-identifier",
"type": "token",
"documentation": "The business identifier of the Enrollment"
}, {
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/EnrollmentRequest-subject",
"type": "reference",
"documentation": "The party to be enrolled"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/EnrollmentRequest-patient",
"type": "reference",
"documentation": "The party to be enrolled"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/EnrollmentRequest-status",
"type": "token",
"documentation": "The status of the enrollment"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 58
} ],
"type": "EnrollmentResponse",
"profile": "http://hl7.org/fhir/StructureDefinition/EnrollmentResponse",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "EnrollmentResponse:request" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/EnrollmentResponse-identifier",
"type": "token",
"documentation": "The business identifier of the EnrollmentResponse"
}, {
"name": "request",
"definition": "http://hl7.org/fhir/SearchParameter/EnrollmentResponse-request",
"type": "reference",
"documentation": "The reference to the claim"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/EnrollmentResponse-status",
"type": "token",
"documentation": "The status of the enrollment response"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 1472
} ],
"type": "EpisodeOfCare",
"profile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare",
"supportedProfile": [ "http://hl7.dk/fhir/core/StructureDefinition/dk-core-episodeOfCare" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "EpisodeOfCare:care-manager", "EpisodeOfCare:condition", "EpisodeOfCare:incoming-referral", "EpisodeOfCare:organization", "EpisodeOfCare:patient" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ChargeItem:context", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:encounter", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:encounter", "DeviceRequest:prior-request", "DiagnosticReport:encounter", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:encounter", "DocumentReference:related", "Encounter:episode-of-care", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "Flag:encounter", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:encounter", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MedicationAdministration:context", "MedicationDispense:context", "MedicationStatement:context", "MessageHeader:focus", "NutritionOrder:encounter", "Observation:encounter", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Procedure:encounter", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "RiskAssessment:encounter", "ServiceRequest:encounter", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target", "VisionPrescription:encounter" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)\r\n* [Composition](composition.html): Kind of composition (LOINC if possible)\r\n* [DocumentManifest](documentmanifest.html): Kind of document set\r\n* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)\r\n* [Encounter](encounter.html): Specific type of encounter\r\n* [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management\r\n"
}, {
"name": "incoming-referral",
"definition": "http://hl7.org/fhir/SearchParameter/EpisodeOfCare-incoming-referral",
"type": "reference",
"documentation": "Incoming Referral Request"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "condition",
"definition": "http://hl7.org/fhir/SearchParameter/EpisodeOfCare-condition",
"type": "reference",
"documentation": "Conditions/problems/diagnoses this episode of care is for"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/EpisodeOfCare-organization",
"type": "reference",
"documentation": "The organization that has assumed the specific responsibilities of this EpisodeOfCare"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "care-manager",
"definition": "http://hl7.org/fhir/SearchParameter/EpisodeOfCare-care-manager",
"type": "reference",
"documentation": "Care manager/care coordinator for the patient"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/EpisodeOfCare-status",
"type": "token",
"documentation": "The current status of the Episode of Care as provided (does not check the status history collection)"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 77
} ],
"type": "EventDefinition",
"profile": "http://hl7.org/fhir/StructureDefinition/EventDefinition",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/EventDefinition-date",
"type": "date",
"documentation": "The event definition publication date"
}, {
"name": "successor",
"definition": "http://hl7.org/fhir/SearchParameter/EventDefinition-successor",
"type": "reference",
"documentation": "What resource is being referenced"
}, {
"name": "context-type-value",
"definition": "http://hl7.org/fhir/SearchParameter/EventDefinition-context-type-value",
"type": "composite",
"documentation": "A use context type and value assigned to the event definition"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/EventDefinition-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the event definition"
}, {
"name": "derived-from",
"definition": "http://hl7.org/fhir/SearchParameter/EventDefinition-derived-from",
"type": "reference",
"documentation": "What resource is being referenced"
}, {
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/EventDefinition-description",
"type": "string",
"documentation": "The description of the event definition"
}, {
"name": "context-type",
"definition": "http://hl7.org/fhir/SearchParameter/EventDefinition-context-type",
"type": "token",
"documentation": "A type of use context assigned to the event definition"
}, {
"name": "predecessor",
"definition": "http://hl7.org/fhir/SearchParameter/EventDefinition-predecessor",
"type": "reference",
"documentation": "What resource is being referenced"
}, {
"name": "composed-of",
"definition": "http://hl7.org/fhir/SearchParameter/EventDefinition-composed-of",
"type": "reference",
"documentation": "What resource is being referenced"
}, {
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/EventDefinition-title",
"type": "string",
"documentation": "The human-friendly name of the event definition"
}, {
"name": "context-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/EventDefinition-context-quantity",
"type": "quantity",
"documentation": "A quantity- or range-valued use context assigned to the event definition"
}, {
"name": "depends-on",
"definition": "http://hl7.org/fhir/SearchParameter/EventDefinition-depends-on",
"type": "reference",
"documentation": "What resource is being referenced"
}, {
"name": "effective",
"definition": "http://hl7.org/fhir/SearchParameter/EventDefinition-effective",
"type": "date",
"documentation": "The time during which the event definition is intended to be in use"
}, {
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/EventDefinition-context",
"type": "token",
"documentation": "A use context assigned to the event definition"
}, {
"name": "context-type-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/EventDefinition-context-type-quantity",
"type": "composite",
"documentation": "A use context type and quantity- or range-based value assigned to the event definition"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/EventDefinition-identifier",
"type": "token",
"documentation": "External identifier for the event definition"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/EventDefinition-version",
"type": "token",
"documentation": "The business version of the event definition"
}, {
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/EventDefinition-url",
"type": "uri",
"documentation": "The uri that identifies the event definition"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/EventDefinition-name",
"type": "string",
"documentation": "Computationally friendly name of the event definition"
}, {
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/EventDefinition-publisher",
"type": "string",
"documentation": "Name of the publisher of the event definition"
}, {
"name": "topic",
"definition": "http://hl7.org/fhir/SearchParameter/EventDefinition-topic",
"type": "token",
"documentation": "Topics associated with the module"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/EventDefinition-status",
"type": "token",
"documentation": "The current status of the event definition"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 100
} ],
"type": "Evidence",
"profile": "http://hl7.org/fhir/StructureDefinition/Evidence",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/Evidence-date",
"type": "date",
"documentation": "The evidence publication date"
}, {
"name": "successor",
"definition": "http://hl7.org/fhir/SearchParameter/Evidence-successor",
"type": "reference",
"documentation": "What resource is being referenced"
}, {
"name": "context-type-value",
"definition": "http://hl7.org/fhir/SearchParameter/Evidence-context-type-value",
"type": "composite",
"documentation": "A use context type and value assigned to the evidence"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/Evidence-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the evidence"
}, {
"name": "derived-from",
"definition": "http://hl7.org/fhir/SearchParameter/Evidence-derived-from",
"type": "reference",
"documentation": "What resource is being referenced"
}, {
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/Evidence-description",
"type": "string",
"documentation": "The description of the evidence"
}, {
"name": "context-type",
"definition": "http://hl7.org/fhir/SearchParameter/Evidence-context-type",
"type": "token",
"documentation": "A type of use context assigned to the evidence"
}, {
"name": "predecessor",
"definition": "http://hl7.org/fhir/SearchParameter/Evidence-predecessor",
"type": "reference",
"documentation": "What resource is being referenced"
}, {
"name": "composed-of",
"definition": "http://hl7.org/fhir/SearchParameter/Evidence-composed-of",
"type": "reference",
"documentation": "What resource is being referenced"
}, {
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/Evidence-title",
"type": "string",
"documentation": "The human-friendly name of the evidence"
}, {
"name": "context-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/Evidence-context-quantity",
"type": "quantity",
"documentation": "A quantity- or range-valued use context assigned to the evidence"
}, {
"name": "depends-on",
"definition": "http://hl7.org/fhir/SearchParameter/Evidence-depends-on",
"type": "reference",
"documentation": "What resource is being referenced"
}, {
"name": "effective",
"definition": "http://hl7.org/fhir/SearchParameter/Evidence-effective",
"type": "date",
"documentation": "The time during which the evidence is intended to be in use"
}, {
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/Evidence-context",
"type": "token",
"documentation": "A use context assigned to the evidence"
}, {
"name": "context-type-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/Evidence-context-type-quantity",
"type": "composite",
"documentation": "A use context type and quantity- or range-based value assigned to the evidence"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Evidence-identifier",
"type": "token",
"documentation": "External identifier for the evidence"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/Evidence-version",
"type": "token",
"documentation": "The business version of the evidence"
}, {
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/Evidence-url",
"type": "uri",
"documentation": "The uri that identifies the evidence"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/Evidence-name",
"type": "string",
"documentation": "Computationally friendly name of the evidence"
}, {
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/Evidence-publisher",
"type": "string",
"documentation": "Name of the publisher of the evidence"
}, {
"name": "topic",
"definition": "http://hl7.org/fhir/SearchParameter/Evidence-topic",
"type": "token",
"documentation": "Topics associated with the Evidence"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Evidence-status",
"type": "token",
"documentation": "The current status of the evidence"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 91
} ],
"type": "EvidenceVariable",
"profile": "http://hl7.org/fhir/StructureDefinition/EvidenceVariable",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/EvidenceVariable-date",
"type": "date",
"documentation": "The evidence variable publication date"
}, {
"name": "successor",
"definition": "http://hl7.org/fhir/SearchParameter/EvidenceVariable-successor",
"type": "reference",
"documentation": "What resource is being referenced"
}, {
"name": "context-type-value",
"definition": "http://hl7.org/fhir/SearchParameter/EvidenceVariable-context-type-value",
"type": "composite",
"documentation": "A use context type and value assigned to the evidence variable"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/EvidenceVariable-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the evidence variable"
}, {
"name": "derived-from",
"definition": "http://hl7.org/fhir/SearchParameter/EvidenceVariable-derived-from",
"type": "reference",
"documentation": "What resource is being referenced"
}, {
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/EvidenceVariable-description",
"type": "string",
"documentation": "The description of the evidence variable"
}, {
"name": "context-type",
"definition": "http://hl7.org/fhir/SearchParameter/EvidenceVariable-context-type",
"type": "token",
"documentation": "A type of use context assigned to the evidence variable"
}, {
"name": "predecessor",
"definition": "http://hl7.org/fhir/SearchParameter/EvidenceVariable-predecessor",
"type": "reference",
"documentation": "What resource is being referenced"
}, {
"name": "composed-of",
"definition": "http://hl7.org/fhir/SearchParameter/EvidenceVariable-composed-of",
"type": "reference",
"documentation": "What resource is being referenced"
}, {
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/EvidenceVariable-title",
"type": "string",
"documentation": "The human-friendly name of the evidence variable"
}, {
"name": "context-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/EvidenceVariable-context-quantity",
"type": "quantity",
"documentation": "A quantity- or range-valued use context assigned to the evidence variable"
}, {
"name": "depends-on",
"definition": "http://hl7.org/fhir/SearchParameter/EvidenceVariable-depends-on",
"type": "reference",
"documentation": "What resource is being referenced"
}, {
"name": "effective",
"definition": "http://hl7.org/fhir/SearchParameter/EvidenceVariable-effective",
"type": "date",
"documentation": "The time during which the evidence variable is intended to be in use"
}, {
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/EvidenceVariable-context",
"type": "token",
"documentation": "A use context assigned to the evidence variable"
}, {
"name": "context-type-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/EvidenceVariable-context-type-quantity",
"type": "composite",
"documentation": "A use context type and quantity- or range-based value assigned to the evidence variable"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/EvidenceVariable-identifier",
"type": "token",
"documentation": "External identifier for the evidence variable"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/EvidenceVariable-version",
"type": "token",
"documentation": "The business version of the evidence variable"
}, {
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/EvidenceVariable-url",
"type": "uri",
"documentation": "The uri that identifies the evidence variable"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/EvidenceVariable-name",
"type": "string",
"documentation": "Computationally friendly name of the evidence variable"
}, {
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/EvidenceVariable-publisher",
"type": "string",
"documentation": "Name of the publisher of the evidence variable"
}, {
"name": "topic",
"definition": "http://hl7.org/fhir/SearchParameter/EvidenceVariable-topic",
"type": "token",
"documentation": "Topics associated with the EvidenceVariable"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/EvidenceVariable-status",
"type": "token",
"documentation": "The current status of the evidence variable"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 71
} ],
"type": "ExampleScenario",
"profile": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/ExampleScenario-date",
"type": "date",
"documentation": "The example scenario publication date"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ExampleScenario-identifier",
"type": "token",
"documentation": "External identifier for the example scenario"
}, {
"name": "context-type-value",
"definition": "http://hl7.org/fhir/SearchParameter/ExampleScenario-context-type-value",
"type": "composite",
"documentation": "A use context type and value assigned to the example scenario"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/ExampleScenario-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the example scenario"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "context-type",
"definition": "http://hl7.org/fhir/SearchParameter/ExampleScenario-context-type",
"type": "token",
"documentation": "A type of use context assigned to the example scenario"
}, {
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/ExampleScenario-version",
"type": "token",
"documentation": "The business version of the example scenario"
}, {
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/ExampleScenario-url",
"type": "uri",
"documentation": "The uri that identifies the example scenario"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "context-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/ExampleScenario-context-quantity",
"type": "quantity",
"documentation": "A quantity- or range-valued use context assigned to the example scenario"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/ExampleScenario-context",
"type": "token",
"documentation": "A use context assigned to the example scenario"
}, {
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/ExampleScenario-name",
"type": "string",
"documentation": "Computationally friendly name of the example scenario"
}, {
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/ExampleScenario-publisher",
"type": "string",
"documentation": "Name of the publisher of the example scenario"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "context-type-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/ExampleScenario-context-type-quantity",
"type": "composite",
"documentation": "A use context type and quantity- or range-based value assigned to the example scenario"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/ExampleScenario-status",
"type": "token",
"documentation": "The current status of the example scenario"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 92925
} ],
"type": "ExplanationOfBenefit",
"profile": "http://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "ExplanationOfBenefit:care-team", "ExplanationOfBenefit:claim", "ExplanationOfBenefit:coverage", "ExplanationOfBenefit:detail-udi", "ExplanationOfBenefit:encounter", "ExplanationOfBenefit:enterer", "ExplanationOfBenefit:facility", "ExplanationOfBenefit:item-udi", "ExplanationOfBenefit:patient", "ExplanationOfBenefit:payee", "ExplanationOfBenefit:procedure-udi", "ExplanationOfBenefit:provider", "ExplanationOfBenefit:subdetail-udi" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "care-team",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-care-team",
"type": "reference",
"documentation": "Member of the CareTeam"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "payee",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-payee",
"type": "reference",
"documentation": "The party receiving any payment for the Claim"
}, {
"name": "provider",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-provider",
"type": "reference",
"documentation": "The reference to the provider"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-patient",
"type": "reference",
"documentation": "The reference to the patient"
}, {
"name": "detail-udi",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-detail-udi",
"type": "reference",
"documentation": "UDI associated with a line item detail product or service"
}, {
"name": "claim",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-claim",
"type": "reference",
"documentation": "The reference to the claim"
}, {
"name": "enterer",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-enterer",
"type": "reference",
"documentation": "The party responsible for the entry of the Claim"
}, {
"name": "procedure-udi",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-procedure-udi",
"type": "reference",
"documentation": "UDI associated with a procedure"
}, {
"name": "item-udi",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-item-udi",
"type": "reference",
"documentation": "UDI associated with a line item product or service"
}, {
"name": "coverage",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-coverage",
"type": "reference",
"documentation": "The plan under which the claim was adjudicated"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-identifier",
"type": "token",
"documentation": "The business identifier of the Explanation of Benefit"
}, {
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-created",
"type": "date",
"documentation": "The creation date for the EOB"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-encounter",
"type": "reference",
"documentation": "Encounters associated with a billed line item"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "disposition",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-disposition",
"type": "string",
"documentation": "The contents of the disposition message"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "subdetail-udi",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-subdetail-udi",
"type": "reference",
"documentation": "UDI associated with a line item detail subdetail product or service"
}, {
"name": "facility",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-facility",
"type": "reference",
"documentation": "Facility responsible for the goods and services"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/ExplanationOfBenefit-status",
"type": "token",
"documentation": "Status of the instance"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 838
} ],
"type": "FamilyMemberHistory",
"profile": "http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "FamilyMemberHistory:instantiates-canonical", "FamilyMemberHistory:patient" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:investigation", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance\r\n* [Condition](condition.html): Code for the condition\r\n* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered\r\n* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code\r\n* [List](list.html): What the purpose of this list is\r\n* [Medication](medication.html): Returns medications for a specific code\r\n* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code\r\n* [MedicationStatement](medicationstatement.html): Return statements of this medication code\r\n* [Observation](observation.html): The code of the observation type\r\n* [Procedure](procedure.html): A code to identify a procedure\r\n* [ServiceRequest](servicerequest.html): What is being requested/ordered\r\n"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "sex",
"definition": "http://hl7.org/fhir/SearchParameter/FamilyMemberHistory-sex",
"type": "token",
"documentation": "A search by a sex code of a family member"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "instantiates-canonical",
"definition": "http://hl7.org/fhir/SearchParameter/FamilyMemberHistory-instantiates-canonical",
"type": "reference",
"documentation": "Instantiates FHIR protocol or definition"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "instantiates-uri",
"definition": "http://hl7.org/fhir/SearchParameter/FamilyMemberHistory-instantiates-uri",
"type": "uri",
"documentation": "Instantiates external protocol or definition"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "relationship",
"definition": "http://hl7.org/fhir/SearchParameter/FamilyMemberHistory-relationship",
"type": "token",
"documentation": "A search by a relationship type"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/FamilyMemberHistory-status",
"type": "token",
"documentation": "partial | completed | entered-in-error | health-unknown"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 1666
} ],
"type": "Flag",
"profile": "http://hl7.org/fhir/StructureDefinition/Flag",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "Flag:author", "Flag:encounter", "Flag:patient", "Flag:subject" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Flag-identifier",
"type": "token",
"documentation": "Business identifier"
}, {
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/Flag-author",
"type": "reference",
"documentation": "Flag creator"
}, {
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Flag-subject",
"type": "reference",
"documentation": "The identity of a subject to list flags for"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-encounter",
"type": "reference",
"documentation": "Multiple Resources: \r\n\r\n* [Composition](composition.html): Context of the Composition\r\n* [DeviceRequest](devicerequest.html): Encounter during which request was created\r\n* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made\r\n* [DocumentReference](documentreference.html): Context of the document content\r\n* [Flag](flag.html): Alert relevant during encounter\r\n* [List](list.html): Context in which list created\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier\r\n* [Observation](observation.html): Encounter related to the observation\r\n* [Procedure](procedure.html): Encounter created as part of\r\n* [RiskAssessment](riskassessment.html): Where was assessment performed?\r\n* [ServiceRequest](servicerequest.html): An encounter in which this request is made\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier\r\n"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 7069
} ],
"type": "Goal",
"profile": "http://hl7.org/fhir/StructureDefinition/Goal",
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "Goal:patient", "Goal:subject" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "CarePlan:goal", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Goal-subject",
"type": "reference",
"documentation": "Who this goal is intended for"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "start-date",
"definition": "http://hl7.org/fhir/SearchParameter/Goal-start-date",
"type": "date",
"documentation": "When goal pursuit begins"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "lifecycle-status",
"definition": "http://hl7.org/fhir/SearchParameter/Goal-lifecycle-status",
"type": "token",
"documentation": "proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "achievement-status",
"definition": "http://hl7.org/fhir/SearchParameter/Goal-achievement-status",
"type": "token",
"documentation": "in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/Goal-category",
"type": "token",
"documentation": "E.g. Treatment, dietary, behavioral, etc."
}, {
"name": "target-date",
"definition": "http://hl7.org/fhir/SearchParameter/Goal-target-date",
"type": "date",
"documentation": "Reach goal on or before"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 77
} ],
"type": "GraphDefinition",
"profile": "http://hl7.org/fhir/StructureDefinition/GraphDefinition",
"supportedProfile": [ "https://who-int.github.io/svc/refs/heads/rc2/StructureDefinition/shf-graphdefinition" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-date",
"type": "date",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n"
}, {
"name": "context-type-value",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context-type-value",
"type": "composite",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-jurisdiction",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "start",
"definition": "http://hl7.org/fhir/SearchParameter/GraphDefinition-start",
"type": "token",
"documentation": "Type of resource at which the graph starts"
}, {
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-description",
"type": "string",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n"
}, {
"name": "context-type",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context-type",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n"
}, {
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-version",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n"
}, {
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-url",
"type": "uri",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "context-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context-quantity",
"type": "quantity",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n"
}, {
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-name",
"type": "string",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n"
}, {
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-publisher",
"type": "string",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "context-type-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity",
"type": "composite",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-status",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 717
} ],
"type": "Group",
"profile": "http://hl7.org/fhir/StructureDefinition/Group",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "Group:managing-entity", "Group:member" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "AdverseEvent:subject", "AllergyIntolerance:patient", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "CarePlan:patient", "CarePlan:subject", "CareTeam:patient", "CareTeam:subject", "ChargeItem:subject", "ClinicalImpression:patient", "ClinicalImpression:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "Communication:recipient", "Communication:subject", "CommunicationRequest:based-on", "CommunicationRequest:recipient", "CommunicationRequest:subject", "Composition:entry", "Composition:patient", "Composition:subject", "Condition:evidence-detail", "Condition:patient", "Condition:subject", "Consent:actor", "Consent:data", "Consent:patient", "Contract:subject", "DetectedIssue:implicated", "DetectedIssue:patient", "DeviceRequest:based-on", "DeviceRequest:patient", "DeviceRequest:prior-request", "DeviceRequest:subject", "DeviceUseStatement:patient", "DeviceUseStatement:subject", "DiagnosticReport:patient", "DiagnosticReport:subject", "DocumentManifest:item", "DocumentManifest:patient", "DocumentManifest:related-ref", "DocumentManifest:subject", "DocumentReference:patient", "DocumentReference:related", "DocumentReference:subject", "Encounter:patient", "Encounter:subject", "EpisodeOfCare:patient", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "FamilyMemberHistory:patient", "Flag:patient", "Flag:subject", "Goal:patient", "Goal:subject", "Group:member", "GuidanceResponse:subject", "ImagingStudy:patient", "ImagingStudy:subject", "Immunization:patient", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Invoice:subject", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "List:patient", "List:subject", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MeasureReport:subject", "Media:subject", "MedicationAdministration:patient", "MedicationAdministration:subject", "MedicationDispense:patient", "MedicationDispense:subject", "MedicationRequest:patient", "MedicationRequest:subject", "MedicationStatement:patient", "MedicationStatement:subject", "MessageHeader:focus", "NutritionOrder:patient", "Observation:focus", "Observation:patient", "Observation:subject", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Procedure:patient", "Procedure:subject", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "RequestGroup:subject", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "RiskAssessment:patient", "RiskAssessment:subject", "ServiceRequest:patient", "ServiceRequest:subject", "Specimen:subject", "SupplyDelivery:patient", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target", "VisionPrescription:patient" ],
"searchParam": [ {
"name": "actual",
"definition": "http://hl7.org/fhir/SearchParameter/Group-actual",
"type": "token",
"documentation": "Descriptive or actual"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Group-identifier",
"type": "token",
"documentation": "Unique id"
}, {
"name": "managing-entity",
"definition": "http://hl7.org/fhir/SearchParameter/Group-managing-entity",
"type": "reference",
"documentation": "Entity that is the custodian of the Group's definition"
}, {
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/Group-code",
"type": "token",
"documentation": "The kind of resources contained"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/Group-type",
"type": "token",
"documentation": "The type of resources the group contains"
}, {
"name": "characteristic",
"definition": "http://hl7.org/fhir/SearchParameter/Group-characteristic",
"type": "token",
"documentation": "Kind of characteristic"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "characteristic-value",
"definition": "http://hl7.org/fhir/SearchParameter/Group-characteristic-value",
"type": "composite",
"documentation": "A composite of both characteristic and value"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "member",
"definition": "http://hl7.org/fhir/SearchParameter/Group-member",
"type": "reference",
"documentation": "Reference to the group member"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "exclude",
"definition": "http://hl7.org/fhir/SearchParameter/Group-exclude",
"type": "token",
"documentation": "Group includes or excludes"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "value",
"definition": "http://hl7.org/fhir/SearchParameter/Group-value",
"type": "token",
"documentation": "Value held by characteristic"
} ],
"operation": [ {
"name": "export",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/GroupPatient-its-export"
}, {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 158
} ],
"type": "GuidanceResponse",
"profile": "http://hl7.org/fhir/StructureDefinition/GuidanceResponse",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "GuidanceResponse:patient", "GuidanceResponse:subject" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/GuidanceResponse-identifier",
"type": "token",
"documentation": "The identifier of the guidance response"
}, {
"name": "request",
"definition": "http://hl7.org/fhir/SearchParameter/GuidanceResponse-request",
"type": "token",
"documentation": "The identifier of the request associated with the response"
}, {
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/GuidanceResponse-subject",
"type": "reference",
"documentation": "The subject that the guidance response is about"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/GuidanceResponse-patient",
"type": "reference",
"documentation": "The identity of a patient to search for guidance response results"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 3347
} ],
"type": "HealthcareService",
"profile": "http://hl7.org/fhir/StructureDefinition/HealthcareService",
"supportedProfile": [ "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-HealthcareService", "https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.HealthcareService" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "HealthcareService:coverage-area", "HealthcareService:endpoint", "HealthcareService:location", "HealthcareService:organization" ],
"searchRevInclude": [ "Account:subject", "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:actor", "Appointment:supporting-info", "AppointmentResponse:actor", "AuditEvent:entity", "Basic:subject", "CarePlan:performer", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "Communication:recipient", "Communication:sender", "CommunicationRequest:based-on", "CommunicationRequest:recipient", "CommunicationRequest:sender", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:performer", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "OrganizationAffiliation:service", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "PractitionerRole:service", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Schedule:actor", "ServiceRequest:performer", "SupplyRequest:supplier", "Task:based-on", "Task:focus", "Task:owner", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-identifier",
"type": "token",
"documentation": "External identifiers for this item"
}, {
"name": "specialty",
"definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-specialty",
"type": "token",
"documentation": "The specialty of the service provided by this healthcare service"
}, {
"name": "service-category",
"definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-service-category",
"type": "token",
"documentation": "Service Category of the Healthcare Service"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "service-type",
"definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-service-type",
"type": "token",
"documentation": "The type of service provided by this healthcare service"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "active",
"definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-active",
"type": "token",
"documentation": "The Healthcare Service is currently marked as active"
}, {
"name": "program",
"definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-program",
"type": "token",
"documentation": "One of the Programs supported by this HealthcareService"
}, {
"name": "characteristic",
"definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-characteristic",
"type": "token",
"documentation": "One of the HealthcareService's characteristics"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "endpoint",
"definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-endpoint",
"type": "reference",
"documentation": "Technical endpoints providing access to electronic services operated for the healthcare service"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "coverage-area",
"definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-coverage-area",
"type": "reference",
"documentation": "Location(s) service is intended for/available to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-organization",
"type": "reference",
"documentation": "The organization that provides this Healthcare Service"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-name",
"type": "string",
"documentation": "A portion of the Healthcare service name"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-location",
"type": "reference",
"documentation": "The location of the Healthcare Service"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 6160
} ],
"type": "ImagingStudy",
"profile": "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"supportedProfile": [ "http://hl7.org/fhir/uv/ips/StructureDefinition/ImagingStudy-uv-ips" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "ImagingStudy:basedon", "ImagingStudy:encounter", "ImagingStudy:endpoint", "ImagingStudy:interpreter", "ImagingStudy:patient", "ImagingStudy:performer", "ImagingStudy:referrer", "ImagingStudy:subject" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ChargeItem:service", "ClinicalImpression:investigation", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:derived-from", "Observation:focus", "Observation:part-of", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "reason",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-reason",
"type": "token",
"documentation": "The reason for the study"
}, {
"name": "dicom-class",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-dicom-class",
"type": "token",
"documentation": "The type of the instance"
}, {
"name": "instance",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-instance",
"type": "token",
"documentation": "SOP Instance UID for an instance"
}, {
"name": "modality",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-modality",
"type": "token",
"documentation": "The modality of the series"
}, {
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-subject",
"type": "reference",
"documentation": "Who the study is about"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "endpoint",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-endpoint",
"type": "reference",
"documentation": "The endpoint for the study or series"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name": "bodysite",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-bodysite",
"type": "token",
"documentation": "The body site studied"
}, {
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-performer",
"type": "reference",
"documentation": "The person who performed the study"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "interpreter",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-interpreter",
"type": "reference",
"documentation": "Who interpreted the images"
}, {
"name": "started",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-started",
"type": "date",
"documentation": "When the study was started"
}, {
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-encounter",
"type": "reference",
"documentation": "The context of the study"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "referrer",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-referrer",
"type": "reference",
"documentation": "The referring physician"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "series",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-series",
"type": "token",
"documentation": "DICOM Series Instance UID for a series"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "basedon",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-basedon",
"type": "reference",
"documentation": "The order for the image"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/ImagingStudy-status",
"type": "token",
"documentation": "The status of the study"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 57814
} ],
"type": "Immunization",
"profile": "http://hl7.org/fhir/StructureDefinition/Immunization",
"supportedProfile": [ "http://build.fhir.org/ig/hitstdio/sample-ig/StructureDefinition/vaccination-credential-immunization", "http://example.org/fhir/StructureDefinition/KRImmunization", "http://hitstdio.ntunhs.edu.tw/ig/lab/smarthealthcards-vaccination/StructureDefinition/vaccination-credential-immunization", "http://hl7.eu/fhir/ig/dgc/StructureDefinition/Immunization-dgc", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization", "http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips", "http://hl7.org/fhir/uv/smarthealthcards-vaccination/StructureDefinition/vaccination-credential-immunization", "https://jembi.github.io/covid19-immunization-ig//StructureDefinition/covid19-immunization" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "Immunization:location", "Immunization:manufacturer", "Immunization:patient", "Immunization:performer", "Immunization:reaction", "Immunization:reason-reference" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "AdverseEvent:substance", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ChargeItem:service", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationEvaluation:immunization-event", "ImmunizationRecommendation:information", "ImmunizationRecommendation:support", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "Observation:part-of", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n"
}, {
"name": "lot-number",
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-lot-number",
"type": "string",
"documentation": "Vaccine Lot Number"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "status-reason",
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-status-reason",
"type": "token",
"documentation": "Reason why the vaccine was not administered"
}, {
"name": "reason-code",
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-reason-code",
"type": "token",
"documentation": "Reason why the vaccine was administered"
}, {
"name": "manufacturer",
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-manufacturer",
"type": "reference",
"documentation": "Vaccine Manufacturer"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n"
}, {
"name": "reaction-date",
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-reaction-date",
"type": "date",
"documentation": "When reaction started"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n"
}, {
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-performer",
"type": "reference",
"documentation": "The practitioner or organization who played a role in the vaccination"
}, {
"name": "reaction",
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-reaction",
"type": "reference",
"documentation": "Additional information on reaction"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "target-disease",
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-target-disease",
"type": "token",
"documentation": "The target disease the dose is being administered against"
}, {
"name": "series",
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-series",
"type": "string",
"documentation": "The series being followed by the provider"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "vaccine-code",
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-vaccine-code",
"type": "token",
"documentation": "Vaccine Product Administered"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "reason-reference",
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-reason-reference",
"type": "reference",
"documentation": "Why immunization occurred"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-location",
"type": "reference",
"documentation": "The service delivery location or facility in which the vaccine was / was to be administered"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-status",
"type": "token",
"documentation": "Immunization event status"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 519
} ],
"type": "ImmunizationEvaluation",
"profile": "http://hl7.org/fhir/StructureDefinition/ImmunizationEvaluation",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "ImmunizationEvaluation:immunization-event", "ImmunizationEvaluation:patient" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImmunizationRecommendation:support", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/ImmunizationEvaluation-date",
"type": "date",
"documentation": "Date the evaluation was generated"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ImmunizationEvaluation-identifier",
"type": "token",
"documentation": "ID of the evaluation"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "dose-status",
"definition": "http://hl7.org/fhir/SearchParameter/ImmunizationEvaluation-dose-status",
"type": "token",
"documentation": "The status of the dose relative to published recommendations"
}, {
"name": "immunization-event",
"definition": "http://hl7.org/fhir/SearchParameter/ImmunizationEvaluation-immunization-event",
"type": "reference",
"documentation": "The vaccine administration event being evaluated"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "target-disease",
"definition": "http://hl7.org/fhir/SearchParameter/ImmunizationEvaluation-target-disease",
"type": "token",
"documentation": "The vaccine preventable disease being evaluated against"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/ImmunizationEvaluation-patient",
"type": "reference",
"documentation": "The patient being evaluated"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/ImmunizationEvaluation-status",
"type": "token",
"documentation": "Immunization evaluation status"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 2266
} ],
"type": "ImmunizationRecommendation",
"profile": "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "ImmunizationRecommendation:information", "ImmunizationRecommendation:patient", "ImmunizationRecommendation:support" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:reason-reference", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DiagnosticReport:based-on", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "Encounter:reason-reference", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:based-on", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-date",
"type": "date",
"documentation": "Date recommendation(s) created"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-identifier",
"type": "token",
"documentation": "Business identifier"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "vaccine-type",
"definition": "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-vaccine-type",
"type": "token",
"documentation": "Vaccine or vaccine group recommendation applies to"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "target-disease",
"definition": "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-target-disease",
"type": "token",
"documentation": "Disease to be immunized against"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-patient",
"type": "reference",
"documentation": "Who this profile is for"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "information",
"definition": "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-information",
"type": "reference",
"documentation": "Patient observations supporting recommendation"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "support",
"definition": "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-support",
"type": "reference",
"documentation": "Past immunizations supporting recommendation"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/ImmunizationRecommendation-status",
"type": "token",
"documentation": "Vaccine recommendation status"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 102
} ],
"type": "ImplementationGuide",
"profile": "http://hl7.org/fhir/StructureDefinition/ImplementationGuide",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "ImplementationGuide:depends-on", "ImplementationGuide:global", "ImplementationGuide:resource" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "CapabilityStatement:guide", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:depends-on", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-date",
"type": "date",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n"
}, {
"name": "context-type-value",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context-type-value",
"type": "composite",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-jurisdiction",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n"
}, {
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-description",
"type": "string",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n"
}, {
"name": "context-type",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context-type",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n"
}, {
"name": "experimental",
"definition": "http://hl7.org/fhir/SearchParameter/ImplementationGuide-experimental",
"type": "token",
"documentation": "For testing purposes, not real usage"
}, {
"name": "global",
"definition": "http://hl7.org/fhir/SearchParameter/ImplementationGuide-global",
"type": "reference",
"documentation": "Profile that all resources must conform to"
}, {
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-title",
"type": "string",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html): The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html): The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): The human-friendly name of the value set\r\n"
}, {
"name": "context-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context-quantity",
"type": "quantity",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n"
}, {
"name": "depends-on",
"definition": "http://hl7.org/fhir/SearchParameter/ImplementationGuide-depends-on",
"type": "reference",
"documentation": "Identity of the IG that this depends on"
}, {
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n"
}, {
"name": "context-type-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity",
"type": "composite",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n"
}, {
"name": "resource",
"definition": "http://hl7.org/fhir/SearchParameter/ImplementationGuide-resource",
"type": "reference",
"documentation": "Location of the resource"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-version",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n"
}, {
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-url",
"type": "uri",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-name",
"type": "string",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n"
}, {
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-publisher",
"type": "string",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-status",
"type": "token",
"documentation": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 260
} ],
"type": "InsurancePlan",
"profile": "http://hl7.org/fhir/StructureDefinition/InsurancePlan",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "InsurancePlan:administered-by", "InsurancePlan:endpoint", "InsurancePlan:owned-by" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/InsurancePlan-identifier",
"type": "token",
"documentation": "Any identifier for the organization (not the accreditation issuer's identifier)"
}, {
"name": "address",
"definition": "http://hl7.org/fhir/SearchParameter/InsurancePlan-address",
"type": "string",
"documentation": "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"
}, {
"name": "address-state",
"definition": "http://hl7.org/fhir/SearchParameter/InsurancePlan-address-state",
"type": "string",
"documentation": "A state specified in an address"
}, {
"name": "owned-by",
"definition": "http://hl7.org/fhir/SearchParameter/InsurancePlan-owned-by",
"type": "reference",
"documentation": "An organization of which this organization forms a part"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/InsurancePlan-type",
"type": "token",
"documentation": "A code for the type of organization"
}, {
"name": "address-postalcode",
"definition": "http://hl7.org/fhir/SearchParameter/InsurancePlan-address-postalcode",
"type": "string",
"documentation": "A postal code specified in an address"
}, {
"name": "address-country",
"definition": "http://hl7.org/fhir/SearchParameter/InsurancePlan-address-country",
"type": "string",
"documentation": "A country specified in an address"
}, {
"name": "administered-by",
"definition": "http://hl7.org/fhir/SearchParameter/InsurancePlan-administered-by",
"type": "reference",
"documentation": "Product administrator"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "endpoint",
"definition": "http://hl7.org/fhir/SearchParameter/InsurancePlan-endpoint",
"type": "reference",
"documentation": "Technical endpoint"
}, {
"name": "phonetic",
"definition": "http://hl7.org/fhir/SearchParameter/InsurancePlan-phonetic",
"type": "string",
"documentation": "A portion of the organization's name using some kind of phonetic matching algorithm"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "address-use",
"definition": "http://hl7.org/fhir/SearchParameter/InsurancePlan-address-use",
"type": "token",
"documentation": "A use code specified in an address"
}, {
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/InsurancePlan-name",
"type": "string",
"documentation": "A portion of the organization's name or alias"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "address-city",
"definition": "http://hl7.org/fhir/SearchParameter/InsurancePlan-address-city",
"type": "string",
"documentation": "A city specified in an address"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/InsurancePlan-status",
"type": "token",
"documentation": "Is the Organization record active"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 687
} ],
"type": "Invoice",
"profile": "http://hl7.org/fhir/StructureDefinition/Invoice",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "Invoice:account", "Invoice:issuer", "Invoice:participant", "Invoice:patient", "Invoice:recipient", "Invoice:subject" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/Invoice-date",
"type": "date",
"documentation": "Invoice date / posting date"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Invoice-identifier",
"type": "token",
"documentation": "Business Identifier for item"
}, {
"name": "totalgross",
"definition": "http://hl7.org/fhir/SearchParameter/Invoice-totalgross",
"type": "quantity",
"documentation": "Gross total of this Invoice"
}, {
"name": "participant-role",
"definition": "http://hl7.org/fhir/SearchParameter/Invoice-participant-role",
"type": "token",
"documentation": "Type of involvement in creation of this Invoice"
}, {
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/Invoice-subject",
"type": "reference",
"documentation": "Recipient(s) of goods and services"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/Invoice-type",
"type": "token",
"documentation": "Type of Invoice"
}, {
"name": "issuer",
"definition": "http://hl7.org/fhir/SearchParameter/Invoice-issuer",
"type": "reference",
"documentation": "Issuing Organization of Invoice"
}, {
"name": "participant",
"definition": "http://hl7.org/fhir/SearchParameter/Invoice-participant",
"type": "reference",
"documentation": "Individual who was involved"
}, {
"name": "totalnet",
"definition": "http://hl7.org/fhir/SearchParameter/Invoice-totalnet",
"type": "quantity",
"documentation": "Net total of this Invoice"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/Invoice-patient",
"type": "reference",
"documentation": "Recipient(s) of goods and services"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "recipient",
"definition": "http://hl7.org/fhir/SearchParameter/Invoice-recipient",
"type": "reference",
"documentation": "Recipient of this invoice"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "account",
"definition": "http://hl7.org/fhir/SearchParameter/Invoice-account",
"type": "reference",
"documentation": "Account that is being balanced"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Invoice-status",
"type": "token",
"documentation": "draft | issued | balanced | cancelled | entered-in-error"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 209
} ],
"type": "Library",
"profile": "http://hl7.org/fhir/StructureDefinition/Library",
"supportedProfile": [ "http://fkcfhir.org/fhir/StructureDefinition/Catalog", "http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/computable-library-cqfm", "http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/executable-library-cqfm", "http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/library-cqfm", "http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/publishable-library-cqfm", "http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/quality-program-cqfm", "http://hl7.org/fhir/uv/saner/StructureDefinition/PublicHealthMeasureLibrary" ],
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-of", "ResearchElementDefinition:depends-on", "ResearchElementDefinition:derived-from", "ResearchElementDefinition:predecessor", "ResearchElementDefinition:successor", "Task:based-on", "Task:focus", "Task:subject", "VerificationResult:target" ],
"searchParam": [ {
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/Library-date",
"type": "date",
"documentation": "The library publication date"
}, {
"name": "successor",
"definition": "http://hl7.org/fhir/SearchParameter/Library-successor",
"type": "reference",
"documentation": "What resource is being referenced"
}, {
"name": "context-type-value",
"definition": "http://hl7.org/fhir/SearchParameter/Library-context-type-value",
"type": "composite",
"documentation": "A use context type and value assigned to the library"
}, {
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
}, {
"name": "jurisdiction",
"definition": "http://hl7.org/fhir/SearchParameter/Library-jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the library"
}, {
"name": "derived-from",
"definition": "http://hl7.org/fhir/SearchParameter/Library-derived-from",
"type": "reference",
"documentation": "What resource is being referenced"
}, {
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/Library-description",
"type": "string",
"documentation": "The description of the library"
}, {
"name": "context-type",
"definition": "http://hl7.org/fhir/SearchParameter/Library-context-type",
"type": "token",
"documentation": "A type of use context assigned to the library"
}, {
"name": "predecessor",
"definition": "http://hl7.org/fhir/SearchParameter/Library-predecessor",
"type": "reference",
"documentation": "What resource is being referenced"
}, {
"name": "composed-of",
"definition": "http://hl7.org/fhir/SearchParameter/Library-composed-of",
"type": "reference",
"documentation": "What resource is being referenced"
}, {
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/Library-title",
"type": "string",
"documentation": "The human-friendly name of the library"
}, {
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/Library-type",
"type": "token",
"documentation": "The type of the library (e.g. logic-library, model-definition, asset-collection, module-definition)"
}, {
"name": "context-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/Library-context-quantity",
"type": "quantity",
"documentation": "A quantity- or range-valued use context assigned to the library"
}, {
"name": "depends-on",
"definition": "http://hl7.org/fhir/SearchParameter/Library-depends-on",
"type": "reference",
"documentation": "What resource is being referenced"
}, {
"name": "effective",
"definition": "http://hl7.org/fhir/SearchParameter/Library-effective",
"type": "date",
"documentation": "The time during which the library is intended to be in use"
}, {
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/Library-context",
"type": "token",
"documentation": "A use context assigned to the library"
}, {
"name": "content-type",
"definition": "http://hl7.org/fhir/SearchParameter/Library-content-type",
"type": "token",
"documentation": "The type of content in the library (e.g. text/cql)"
}, {
"name": "context-type-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/Library-context-type-quantity",
"type": "composite",
"documentation": "A use context type and quantity- or range-based value assigned to the library"
}, {
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Library-identifier",
"type": "token",
"documentation": "External identifier for the library"
}, {
"name": "_security",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-security",
"type": "token",
"documentation": "Security Labels applied to this resource"
}, {
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/Library-version",
"type": "token",
"documentation": "The business version of the library"
}, {
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/Library-url",
"type": "uri",
"documentation": "The uri that identifies the library"
}, {
"name": "_filter",
"type": "string",
"documentation": "Search the contents of the resource's data using a filter"
}, {
"name": "_profile",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
"type": "uri",
"documentation": "Profiles this resource claims to conform to"
}, {
"name": "_tag",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-tag",
"type": "token",
"documentation": "Tags applied to this resource"
}, {
"name": "_has",
"type": "string",
"documentation": "Return resources linked to by the given target"
}, {
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/Library-name",
"type": "string",
"documentation": "Computationally friendly name of the library"
}, {
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/Library-publisher",
"type": "string",
"documentation": "Name of the publisher of the library"
}, {
"name": "topic",
"definition": "http://hl7.org/fhir/SearchParameter/Library-topic",
"type": "token",
"documentation": "Topics associated with the module"
}, {
"name": "_source",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
"type": "uri",
"documentation": "Identifies where the resource comes from"
}, {
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id of this artifact"
}, {
"name": "_text",
"definition": "http://hl7.org/fhir/SearchParameter/DomainResource-text",
"type": "string",
"documentation": "Search on the narrative of the resource"
}, {
"name": "_content",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"type": "string",
"documentation": "Search on the entire content of the resource"
}, {
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Library-status",
"type": "token",
"documentation": "The current status of the library"
} ],
"operation": [ {
"name": "validate",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-it-validate"
}, {
"name": "meta-delete",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-delete",
"documentation": "Delete tags, profiles, and/or security labels from a resource"
}, {
"name": "meta-add",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-i-meta-add",
"documentation": "Add tags, profiles, and/or security labels to a resource"
}, {
"name": "meta",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-meta",
"documentation": "Request a list of tags, profiles, and security labels for a specfic resource instance"
}, {
"name": "expunge",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Multi-its-expunge"
}, {
"name": "diff",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-diff",
"documentation": "This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences."
}, {
"name": "reindex-dryrun",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-i-reindex-dryrun"
}, {
"name": "reindex",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-reindex"
}, {
"name": "graphql",
"definition": "https://hapi.fhir.org/baseR4/OperationDefinition/Global-is-graphql",
"documentation": "This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format."
} ]
}, {
"extension": [ {
"url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
"valueDecimal": 81
} ],
"type": "Linkage",
"profile": "http://hl7.org/fhir/StructureDefinition/Linkage",
"interaction": [ {
"code": "search-type"
}, {
"code": "update"
}, {
"code": "vread"
}, {
"code": "read"
}, {
"code": "patch"
}, {
"code": "history-type"
}, {
"code": "history-instance"
}, {
"code": "delete"
}, {
"code": "create"
} ],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "multiple",
"searchInclude": [ "*", "Linkage:author", "Linkage:item", "Linkage:source" ],
"searchRevInclude": [ "ActivityDefinition:composed-of", "ActivityDefinition:depends-on", "ActivityDefinition:derived-from", "ActivityDefinition:predecessor", "ActivityDefinition:successor", "Appointment:supporting-info", "AuditEvent:entity", "Basic:subject", "ClinicalImpression:supporting-info", "Communication:based-on", "Communication:part-of", "CommunicationRequest:based-on", "Composition:entry", "Composition:subject", "Condition:evidence-detail", "Consent:data", "Contract:subject", "DetectedIssue:implicated", "DeviceRequest:based-on", "DeviceRequest:prior-request", "DocumentManifest:item", "DocumentManifest:related-ref", "DocumentReference:related", "EventDefinition:composed-of", "EventDefinition:depends-on", "EventDefinition:derived-from", "EventDefinition:predecessor", "EventDefinition:successor", "Evidence:composed-of", "Evidence:depends-on", "Evidence:derived-from", "Evidence:predecessor", "Evidence:successor", "EvidenceVariable:composed-of", "EvidenceVariable:depends-on", "EvidenceVariable:derived-from", "EvidenceVariable:predecessor", "EvidenceVariable:successor", "ImmunizationRecommendation:information", "ImplementationGuide:resource", "Library:composed-of", "Library:depends-on", "Library:derived-from", "Library:predecessor", "Library:successor", "Linkage:item", "Linkage:source", "List:item", "Measure:composed-of", "Measure:depends-on", "Measure:derived-from", "Measure:predecessor", "Measure:successor", "MeasureReport:evaluated-resource", "MessageHeader:focus", "Observation:focus", "PaymentNotice:request", "PaymentNotice:response", "PlanDefinition:composed-of", "PlanDefinition:depends-on", "PlanDefinition:derived-from", "PlanDefinition:predecessor", "PlanDefinition:successor", "Provenance:entity", "Provenance:target", "QuestionnaireResponse:subject", "RequestGroup:instantiates-canonical", "ResearchDefinition:composed-of", "ResearchDefinition:depends-on", "ResearchDefinition:derived-from", "ResearchDefinition:predecessor", "ResearchDefinition:successor", "ResearchElementDefinition:composed-o
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment