API Name: get-pcp-list


This API allows request for a specific or full list of PCPs information

Specification


Endpoint [baseurl]/Organization/$get-pcp-list
Protocol HTTPS
HTTP Method POST
HTTP Header Content-Type: application/fhir+json
Pagination Yes
Target System Consumer App/ HSG CRM

API Spec

This operation does NOT change content

Parameters (In)

NameCardinalityTypeDocumentation
hci-code0..1string

Search value string for organization identifier HCI Code.

active1..1boolean

Search value boolean for organization status.

_count0..1integer

For pagination use, specify number of records per page, default is 10.

_skip0..1integer

For pagination use, specify number of records to skip, default is 0.

Return Values (Out)

NameCardinalityTypeDocumentation
return1..1Bundle

Participating Organization

Request Body

Remarks:

  • (All Slices) is an automatically generated section and should be ignored. Do not pass this as an input parameter. It will also not be part of response.
idΣ0..0id
metaΣ0..0Meta
implicitRulesΣ ?!0..0uri
language0..0codeBinding
id0..1id
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
nameΣ1..1string
valueAddressAddress
valueAgeAge
valueAnnotationAnnotation
valueAttachmentAttachment
valueBase64Binarybase64Binary
valueBooleanboolean
valueCanonicalcanonical
valueCodecode
valueCodeableConceptCodeableConcept
valueCodingCoding
valueContactDetailContactDetail
valueContactPointContactPoint
valueContributorContributor
valueCountCount
valueDataRequirementDataRequirement
valueDatedate
valueDateTimedateTime
valueDecimaldecimal
valueDistanceDistance
valueDosageDosage
valueDurationDuration
valueExpressionExpression
valueHumanNameHumanName
valueIdid
valueIdentifierIdentifier
valueInstantinstant
valueIntegerinteger
valueMarkdownmarkdown
valueMetaMeta
valueMoneyMoney
valueOidoid
valueParameterDefinitionParameterDefinition
valuePeriodPeriod
valuePositiveIntpositiveInt
valueQuantityQuantity
valueRangeRange
valueRatioRatio
valueReferenceReference
valueRelatedArtifactRelatedArtifact
valueSampledDataSampledData
valueSignatureSignature
valueStringstring
valueTimetime
valueTimingTiming
valueTriggerDefinitionTriggerDefinition
valueUnsignedIntunsignedInt
valueUriuri
valueUrlurl
valueUsageContextUsageContext
valueUuiduuid
resourceΣ C0..1Resource
partΣ0..*see (parameter)
id0..0id
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
nameΣ1..1stringFixed Value
valueStringstring
resourceΣ C0..0Resource
partΣ0..0see (parameter)
id0..0id
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
nameΣ1..1stringFixed Value
valueBooleanboolean
resourceΣ C0..0Resource
partΣ0..0see (parameter)
id0..0id
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
nameΣ1..1stringFixed Value
valueIntegerinteger
resourceΣ C0..0Resource
partΣ0..0see (parameter)
id0..0id
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
nameΣ1..1stringFixed Value
valueIntegerinteger
resourceΣ C0..0Resource
partΣ0..0see (parameter)

Successful Response

Remarks:

  • (All Slices) is an automatically generated section and should be ignored. Do not pass this as an input parameter. It will also not be part of response.
  • The details of the following elements contain an 'Examples' section that is automatically generated and should be ignored.
    • Organization.identifier.system
    • Organization.identifier.value
    • Organization.address.type
    • Organization.address.text
    • Organization.address.line
    • Organization.address.postalCode
idΣ1..1id
id0..0id
extensionC0..0Extension
versionIdΣ0..0id
lastUpdatedΣ1..1instant
sourceΣ0..0uri
profileΣ0..0canonical(StructureDefinition)
securityΣ0..0CodingBinding
implicitRulesΣ ?!0..0uri
language0..0codeBinding
identifierΣ0..0Identifier
typeΣ1..1codeBindingFixed Value
timestampΣ0..0instant
totalΣ C1..1unsignedInt
id0..0id
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
relationΣ1..1string
urlΣ1..1uri
id0..1id
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
fullUrlΣ0..1uri
resourceΣ0..1Resource
id0..1id
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
modeΣ0..1codeBinding
scoreΣ0..1decimal
id0..1id
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
id0..1id
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
id0..0id
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
fullUrlΣ1..1uriPattern
resourceΣ C1..1profile-Organization-get-pcp-list-participatingPcp
id0..0id
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
fullUrlΣ1..1uriPattern
resourceΣ C1..1profile-Organization-get-pcp-list-primaryPcp
id0..0id
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
fullUrlΣ1..1uriPattern
resourceΣ C1..1profile-Organization-get-pcp-list-organizationAffiliation
signatureΣ0..0Signature

idΣ1..1id
id0..0id
extensionC0..0Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..0uri
profileΣ0..0canonical(StructureDefinition)
securityΣ0..0CodingBinding
id0..0id
extensionC0..0Extension
systemΣ0..1uri
versionΣ0..0string
codeΣ0..1code
displayΣ0..0string
userSelectedΣ0..0boolean
implicitRulesΣ ?!0..0uri
language0..0codeBinding
text0..0Narrative
containedC0..0Resource
extensionC0..0Extension
modifierExtension?! C0..0Extension
id0..0id
extensionC0..0Extension
useΣ ?!0..1codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ C0..0Period
assignerΣ C0..0Reference(Organization)
activeΣ ?!1..1boolean
id0..0id
extensionC0..0Extension
id0..0id
extensionC0..0Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..0boolean
textΣ0..0string
nameΣ C1..1string
alias0..0string
telecomC0..0ContactPoint
addressC0..0Address
partOfΣ C0..0Reference(Organization)
endpointC0..0Reference(Endpoint)

idΣ1..1id
id0..0id
extensionC0..0Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..0uri
profileΣ0..0canonical(StructureDefinition)
securityΣ0..0CodingBinding
id0..0id
extensionC0..0Extension
systemΣ0..1uri
versionΣ0..0string
codeΣ0..1code
displayΣ0..0string
userSelectedΣ0..0boolean
implicitRulesΣ ?!0..0uri
language0..0codeBinding
text0..0Narrative
containedC0..0Resource
id0..0id
extensionC0..0Extension
url1..1uriFixed Value
id0..1id
extensionC0..*Extension
id0..0id
extensionC0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..0string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..0boolean
textΣ0..0string
id0..0id
extensionC0..0Extension
url1..1uriFixed Value
valueIntegerinteger
id0..0id
extensionC0..0Extension
url1..1uriFixed Value
valueIntegerinteger
id0..0id
extensionC0..0Extension
url1..1uriFixed Value
valueStringstring
id0..0id
extensionC0..0Extension
url1..1uriFixed Value
id0..0id
extensionC0..0Extension
id0..0id
extensionC0..0Extension
systemΣ1..1uriFixed Value
versionΣ0..0string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..0boolean
textΣ0..0string
modifierExtension?! C0..0Extension
id0..0id
extensionC0..0Extension
useΣ ?!0..1codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
id0..0id
extensionC0..0Extension
startΣ C1..1dateTime
endΣ C0..1dateTime
assignerΣ C0..0Reference(Organization)
activeΣ ?!1..1boolean
id0..0id
extensionC0..0Extension
id0..0id
extensionC0..0Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..0boolean
textΣ0..0string
nameΣ C1..1string
alias0..0string
id0..0id
extensionC0..0Extension
systemΣ C0..1codeBinding
valueΣ0..1string
useΣ ?!0..0codeBinding
rankΣ0..0positiveInt
periodΣ C0..0Period
id0..0id
extensionC0..0Extension
useΣ ?!0..0codeBinding
typeΣ1..1codeBinding
textΣ1..1string
lineΣ1..*string
cityΣ0..0string
districtΣ0..0string
stateΣ0..0string
postalCodeΣ1..1string
countryΣ0..0string
periodΣ C0..0Period
partOfΣ C0..0Reference(Organization)
id0..0id
id0..0id
extensionC0..0Extension
url1..1uriFixed Value
valueStringstring
modifierExtensionΣ ?! C0..*Extension
purpose0..0CodeableConceptBinding
id0..0id
extensionC0..0Extension
useΣ ?!0..0codeBinding
textΣ0..1string
familyΣ0..0string
givenΣ0..0string
prefixΣ0..0string
suffixΣ0..0string
periodΣ C0..0Period
telecomC0..0ContactPoint
address0..0Address
endpointC0..0Reference(Endpoint)

idΣ0..0id
metaΣ0..1Meta
implicitRulesΣ ?!0..0uri
language0..0codeBinding
text0..0Narrative
containedC0..0Resource
extensionC0..0Extension
modifierExtension?! C0..0Extension
identifierΣ0..0Identifier
activeΣ1..1boolean
id0..0id
extensionC0..0Extension
startΣ C1..1dateTime
endΣ C0..1dateTime
id0..0id
extensionC0..0Extension
referenceΣ C1..1string
typeΣ0..0uriBinding
displayΣ0..0string
id0..0id
extensionC0..0Extension
referenceΣ C1..1string
typeΣ0..0uriBinding
displayΣ0..0string
networkΣ C0..0Reference(Organization)
id0..0id
extensionC0..0Extension
id0..0id
extensionC0..0Extension
systemΣ1..1uriFixed Value
versionΣ0..0string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..0boolean
textΣ0..0string
specialtyΣ0..0CodeableConceptBinding
locationΣ C0..0Reference(Location)
healthcareServiceC0..0Reference(HealthcareService)
telecomΣ C0..0ContactPoint
endpointC0..0Reference(Endpoint)

Error Response

Click here for General API Error Handling

Custom Error Codes

Refer to Custom Error Codes for the list of custom error codes specific to this API.