R6 Ballot (3rd Draft) FHIR CI-Build

This page is part of the FHIR Specification v6.0.0-ballot3: Release 6 Ballot (3rd Draft) (see Ballot Notes ). The current version is 5.0.0 . For a full list Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

8.9.14 Resource Endpoint - Search Parameters

Maturity Level : N/A
Responsible Owner: Patient Administration icon Work Group   Trial Use Normative Security Category : Business Compartments : No defined compartments

Search parameters for the Endpoint resource. Also check the Extensions registry for search parameters on extensions related to this resource.

The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

http://hl7.org/fhir/SearchParameter/Endpoint-connection-type

Generated Narrative: SearchParameter Endpoint-connection-type

8.9.15 connection-type

Parameter connection-type : token

Protocol/Profile/Standard to be used with this endpoint connection

Resource Endpoint
Expression Endpoint.connectionType
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Endpoint-identifier

Generated Narrative: SearchParameter Endpoint-identifier

8.9.16 identifier

Parameter identifier : token

Identifies this endpoint across multiple systems

Resource Endpoint
Expression Endpoint.identifier
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Endpoint-name

Generated Narrative: SearchParameter Endpoint-name

8.9.17 name

Parameter name : string

A name that this endpoint can be identified by

Resource Endpoint
Expression Endpoint.name
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Endpoint-organization

Generated Narrative: SearchParameter Endpoint-organization

8.9.18 organization

Parameter organization : reference

The organization that is managing the endpoint

Resource Endpoint
Expression Endpoint.managingOrganization
Processing Mode Normal
Target Resources Organization
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Endpoint-payload-profile

Generated Narrative: SearchParameter Endpoint-payload-profile

8.9.19 payload-profile

Parameter payload-profile : reference

The profiles (FHIR or non-FHIR) that might be used at this endpoint

Resource Endpoint
Expression Endpoint.payload.profileCanonical | Endpoint.payload.profileUri
Processing Mode Normal
Target Resources ActivityDefinition , ActorDefinition , CapabilityStatement , CodeSystem , CompartmentDefinition , Composition , ConceptMap , Contract , DeviceDefinition , EventDefinition , Evidence , EvidenceVariable , ExampleScenario , Group , ImplementationGuide , Library , Measure , MessageDefinition , NamingSystem , ObservationDefinition , OperationDefinition , PlanDefinition , Questionnaire , Requirements , ResearchStudy , SearchParameter , SpecimenDefinition , StructureDefinition , StructureMap , SubscriptionTopic , TerminologyCapabilities , ValueSet
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Endpoint-payload-type

Generated Narrative: SearchParameter Endpoint-payload-type

8.9.19 8.9.20 payload-type

Parameter payload-type : token

The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)

Resource Endpoint
Expression Endpoint.payload.type
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Endpoint-status

Generated Narrative: SearchParameter Endpoint-status

8.9.20 8.9.21 status

Parameter status : token

The current status of the Endpoint (usually expected to be active)

Resource Endpoint
Expression Endpoint.status
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true