ImmPort
Upload
How to Upload Data
Search Private Data
Study Registration
Upload Data Package
Validate Data Package
Shared
Analysis
Resources
Data Management and Sharing Plan
Data
Download
Upload
Tutorials
Analyze
About
Contact ImmPort
About ImmPort
Cite ImmPort
Events
News
Newsletter
Data Summary
Team
Data Providers
Patient
Resource
Server: Local Tester
Local Tester
Global Tester
Source Code
About This Server
Login
Options
Encoding
(default)
XML
JSON
Pretty
(default)
On
Off
Summary
(none)
true
text
data
count
Server
Server Home/Actions
Resources
Observation
3890982
Specimen
587947
DiagnosticReport
263988
ActivityDefinition
179274
ResearchSubject
172835
Patient
167134
PlanDefinition
8614
Group
5570
PractitionerRole
1531
Practitioner
1224
ResearchStudy
1174
Organization
662
RelatedPerson
609
EvidenceVariable
99
Account
ActorDefinition
AdministrableProductDefinition
AdverseEvent
AllergyIntolerance
Appointment
AppointmentResponse
ArtifactAssessment
AuditEvent
Basic
Binary
BiologicallyDerivedProduct
BiologicallyDerivedProductDispense
BodyStructure
Bundle
CapabilityStatement
CarePlan
CareTeam
ChargeItem
ChargeItemDefinition
Citation
Claim
ClaimResponse
ClinicalImpression
ClinicalUseDefinition
CodeSystem
Communication
CommunicationRequest
CompartmentDefinition
Composition
ConceptMap
Condition
ConditionDefinition
Consent
Contract
Coverage
CoverageEligibilityRequest
CoverageEligibilityResponse
DetectedIssue
Device
DeviceAssociation
DeviceDefinition
DeviceDispense
DeviceMetric
DeviceRequest
DeviceUsage
DocumentReference
Encounter
EncounterHistory
Endpoint
EnrollmentRequest
EnrollmentResponse
EpisodeOfCare
EventDefinition
Evidence
EvidenceReport
ExampleScenario
ExplanationOfBenefit
FamilyMemberHistory
Flag
FormularyItem
GenomicStudy
Goal
GraphDefinition
GuidanceResponse
HealthcareService
ImagingSelection
ImagingStudy
Immunization
ImmunizationEvaluation
ImmunizationRecommendation
ImplementationGuide
Ingredient
InsurancePlan
InventoryItem
InventoryReport
Invoice
Library
Linkage
List
Location
ManufacturedItemDefinition
Measure
MeasureReport
Medication
MedicationAdministration
MedicationDispense
MedicationKnowledge
MedicationRequest
MedicationStatement
MedicinalProductDefinition
MessageDefinition
MessageHeader
MolecularSequence
NamingSystem
NutritionIntake
NutritionOrder
NutritionProduct
ObservationDefinition
OperationDefinition
OperationOutcome
OrganizationAffiliation
PackagedProductDefinition
Parameters
PaymentNotice
PaymentReconciliation
Permission
Person
Procedure
Provenance
Questionnaire
QuestionnaireResponse
RegulatedAuthorization
RequestOrchestration
Requirements
RiskAssessment
Schedule
SearchParameter
ServiceRequest
Slot
SpecimenDefinition
StructureDefinition
StructureMap
Subscription
SubscriptionStatus
SubscriptionTopic
Substance
SubstanceDefinition
SubstanceNucleicAcid
SubstancePolymer
SubstanceProtein
SubstanceReferenceInformation
SubstanceSourceMaterial
SupplyDelivery
SupplyRequest
Task
TerminologyCapabilities
TestPlan
TestReport
TestScript
Transport
ValueSet
VerificationResult
VisionPrescription
This is a RESTful server tester, which can be used to send requests to, and receive responses from the server at the following URL:
https://fhir.immport.org/fhir
Resource: Patient
This page contains various operations for interacting with the Patient resource.
Search
Queries
CRUD Operations
Search
Search Parameters
Optionally add parameter(s) to the search
birthdate - Multiple Resources: * [Patient](patient.html): The patient's date of birth * [Person](person.html): The person's date of birth * [RelatedPerson](relatedperson.html): The Related Person's date of birth
deceased - This patient has been marked as deceased, or has a death date entered
address-state - Multiple Resources: * [Patient](patient.html): A state specified in an address * [Person](person.html): A state specified in an address * [Practitioner](practitioner.html): A state specified in an address * [RelatedPerson](relatedperson.html): A state specified in an address
gender - Multiple Resources: * [Patient](patient.html): Gender of the patient * [Person](person.html): The gender of the person * [Practitioner](practitioner.html): Gender of the practitioner * [RelatedPerson](relatedperson.html): Gender of the related person
_lastUpdated - Only return resources which were last updated as specified by the given range
link - All patients/related persons linked to the given patient
language - Language code (irrespective of use value)
address-country - Multiple Resources: * [Patient](patient.html): A country specified in an address * [Person](person.html): A country specified in an address * [Practitioner](practitioner.html): A country specified in an address * [RelatedPerson](relatedperson.html): A country specified in an address
death-date - The date of death has been provided and satisfies this search value
phonetic - Multiple Resources: * [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm * [Person](person.html): A portion of name using some kind of phonetic matching algorithm * [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm * [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm
telecom - Multiple Resources: * [Patient](patient.html): The value in any kind of telecom details of the patient * [Person](person.html): The value in any kind of contact * [Practitioner](practitioner.html): The value in any kind of contact * [PractitionerRole](practitionerrole.html): The value in any kind of contact * [RelatedPerson](relatedperson.html): The value in any kind of contact
address-city - Multiple Resources: * [Patient](patient.html): A city specified in an address * [Person](person.html): A city specified in an address * [Practitioner](practitioner.html): A city specified in an address * [RelatedPerson](relatedperson.html): A city specified in an address
email - Multiple Resources: * [Patient](patient.html): A value in an email contact * [Person](person.html): A value in an email contact * [Practitioner](practitioner.html): A value in an email contact * [PractitionerRole](practitionerrole.html): A value in an email contact * [RelatedPerson](relatedperson.html): A value in an email contact
given - Multiple Resources: * [Patient](patient.html): A portion of the given name of the patient * [Practitioner](practitioner.html): A portion of the given name
identifier - A patient identifier
address - Multiple Resources: * [Patient](patient.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text * [Person](person.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text * [Practitioner](practitioner.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text * [RelatedPerson](relatedperson.html): 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
general-practitioner - Patient's nominated general practitioner, not the organization that manages the record
_security - Search for resources which have the given security labels
active - Whether the patient record is active
part-agree - Search by url for a participation agreement, which is stored as an extension referencing a DocumentReference
address-postalcode - Multiple Resources: * [Patient](patient.html): A postalCode specified in an address * [Person](person.html): A postal code specified in an address * [Practitioner](practitioner.html): A postalCode specified in an address * [RelatedPerson](relatedperson.html): A postal code specified in an address
_filter - Search the contents of the resource's data using a filter
_profile - Search for resources which have the given profile
phone - Multiple Resources: * [Patient](patient.html): A value in a phone contact * [Person](person.html): A value in a phone contact * [Practitioner](practitioner.html): A value in a phone contact * [PractitionerRole](practitionerrole.html): A value in a phone contact * [RelatedPerson](relatedperson.html): A value in a phone contact
organization - The organization that is the custodian of the patient record
_has - Return resources linked to by the given target
_tag - Search for resources which have the given tag
address-use - Multiple Resources: * [Patient](patient.html): A use code specified in an address * [Person](person.html): A use code specified in an address * [Practitioner](practitioner.html): A use code specified in an address * [RelatedPerson](relatedperson.html): A use code specified in an address
name - A server defined search that may match any of the string fields in the HumanName, including family, given, prefix, suffix, and/or text
_source - Search for resources which have the given source value (Resource.meta.source)
_id - The ID of the resource
_text - Search on the narrative of the resource
family - Multiple Resources: * [Patient](patient.html): A portion of the family name of the patient * [Practitioner](practitioner.html): A portion of the family name
_content - Search the contents of the resource's data using a fulltext search
birthdate - Multiple Resources: * [Patient](patient.html): The patient's date of birth * [Person](person.html): The person's date of birth * [RelatedPerson](relatedperson.html): The Related Person's date of birth
eq
eq
gt
ge
lt
le
eq
eq
gt
ge
lt
le
Includes
Also include resources which are referenced by the search results
*
Patient:general-practitioner
Patient:link
Patient:organization
Patient:part-agree
Sort Results
Sort By
Default
Default Sort
Default Sort
_content
_filter
_has
_id
_lastUpdated
_profile
_security
_source
_tag
_text
active
address
address-city
address-country
address-postalcode
address-state
address-use
birthdate
death-date
deceased
email
family
gender
general-practitioner
given
identifier
language
link
name
organization
part-agree
phone
phonetic
telecom
Direction
Default
Default Sort
Default
Ascending
Descending
Other Options
Limit
Reverse Includes
Also include resources which reference to the search results
*
Read
an individual resource instance given its ID (and optionally a version ID to retrieve a specific version of that instance to
vread
that instance)
Read
ID
*
Version ID
Retrieve the update
history
across the Patient resource type, or against a specific instance of this resource type if an ID is specified.
History
ID
Since
Limit
Delete
an individual instance of the resource
Delete
ID
*
Create
an instance of the resource. Generally you do not need to specify an ID but you may force the server to use a specific ID by including one.
Create
ID
Contents
*
Update
an existing instance of the resource by ID.
Update
ID
*
Contents
*
Validate
an instance of the resource to check whether it would be acceptable for creating/updating, without actually storing it on the server.
Validate
Contents
*