The US Core Server SHALL:
\nSupport the US Core Patient resource profile AND at least one additional resource profile from the list of US Core Profiles AND and all Must Support US Core Profiles and resources it references.
\nFollow the narrative requirements documented in the:
\nThe Server Requirements Table and US Core Server Requirements Resource and US Core Certifying System Requirements Resource list the requirements defined in these pages and sections.
\nReturn the following response classes:
\nSupport JSON source formats for all US Core interactions.
\nThe US Core Server SHOULD:
\nmeta.profile attribute for each instance.\n\nNOTE: US Core SearchParameters referenced in this CapabilityStatement that are derived from standard FHIR SearchParameters are only defined to document Server and Client expectations. They specify additional expectations for the following SearchParameter elements:
\n\n
\n- \n
multipleAnd- \n
multipleOr- \n
comparator- \n
modifier- \n
chainThey SHALL NOT be interpreted as search parameters for search. Servers and Clients SHOULD use the standard FHIR SearchParameters.
\n
Security:
\n \nHTTP 401 \"Unauthorized\", HTTP 403 \"Forbidden\", or HTTP 404 \"Not Found\"transaction interaction.batch interaction.search-system interaction.history-system interaction.| Resource Type | \n \nSupported Profiles | \nSupported Searches | \nSupported _includes | \n Supported _revincludes | \n Supported Operations | \n
|---|---|---|---|---|---|
| \n AllergyIntolerance\n | \n\n \n\n \n\n \n \n \n \n \n •US Core AllergyIntolerance Profile \n \n \n \n | \n\n \n \n \n clinical-status, patient\n \n \n , patient+clinical-status\n \n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n Provenance:target\n \n | \n\n \n\n \n -\n \n | \n
| \n CarePlan\n | \n\n \n\n \n\n \n \n \n \n \n •US Core CarePlan Profile \n \n \n \n | \n\n \n \n \n category, date, patient, status\n \n \n , patient+category+status, patient+category, patient+category+date, patient+category+status+date\n \n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n Provenance:target\n \n | \n\n \n\n \n -\n \n | \n
| \n CareTeam\n | \n\n \n\n \n\n \n \n \n \n \n •US Core CareTeam Profile \n \n \n \n | \n\n \n \n \n patient, role, status\n \n \n , patient+status, patient+role\n \n \n | \n\n \n\n \n CareTeam:participant:PractitionerRole\nCareTeam:participant:Practitioner\nCareTeam:participant:Patient\nCareTeam:participant:RelatedPerson\n \n | \n\n \n\n \n Provenance:target\n \n | \n\n \n\n \n -\n \n | \n
| \n Condition\n | \n\n \n\n \n\n \n \n \n \n \n •US Core Condition Encounter Diagnosis Profile \n \n \n \n \n \n •US Core Condition Problems and Health Concerns Profile \n \n \n \n | \n\n \n \n \n abatement-date, asserted-date, category, clinical-status, code, encounter, onset-date, patient, recorded-date, _lastUpdated\n \n \n , patient+clinical-status, patient+code, patient+category, patient+abatement-date, patient+recorded-date, patient+_lastUpdated, patient+asserted-date, patient+category+clinical-status, patient+onset-date, patient+category+encounter\n \n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n Provenance:target\n \n | \n\n \n\n \n -\n \n | \n
| \n Coverage\n | \n\n \n\n \n\n \n \n \n \n \n •US Core Coverage Profile \n \n \n \n | \n\n \n \n \n patient\n \n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n Provenance:target\n \n | \n\n \n\n \n -\n \n | \n
| \n Device\n | \n\n \n\n \n\n \n \n \n \n \n •US Core Device Profile \n \n \n \n | \n\n \n \n \n patient, status, type\n \n \n , patient+type, patient+status\n \n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n Provenance:target\n \n | \n\n \n\n \n -\n \n | \n
| \n DiagnosticReport\n | \n\n \n\n \n\n \n \n \n \n \n •US Core DiagnosticReport Profile for Report and Note exchange \n \n \n \n \n \n •US Core DiagnosticReport Profile for Laboratory Results Reporting \n \n \n \n | \n\n \n \n \n category, code, date, _lastUpdated, patient, status\n \n \n , patient+code+date, patient+category+_lastUpdated, patient+category+date, patient+category, patient+status, patient+code\n \n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n Provenance:target\n \n | \n\n \n\n \n -\n \n | \n
| \n DocumentReference\n | \n\n \n\n \n\n \n \n \n \n \n •US Core DocumentReference Profile \n \n \n \n \n \n •US Core ADI DocumentReference Profile \n \n \n \n | \n\n \n \n \n _id, category, date, patient, period, status, type\n \n \n , patient+type, patient+category+date, patient+category, patient+type+period, patient+status\n \n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n Provenance:target\n \n | \n\n \n\n \n $docref\n \n | \n
| \n Encounter\n | \n\n \n\n \n\n \n \n \n \n \n •US Core Encounter Profile \n \n \n \n | \n\n \n \n \n _id, class, date, _lastUpdated, discharge-disposition, identifier, location, patient, status, type\n \n \n , patient+type, class+patient, patient+status, patient+_lastUpdated, patient+location, date+patient, patient+discharge-disposition\n \n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n Provenance:target\n \n | \n\n \n\n \n -\n \n | \n
| \n Endpoint\n | \n\n \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n
| \n FamilyMemberHistory\n | \n\n \n\n \n\n \n \n \n \n \n •US Core FamilyMemberHistory Profile \n \n \n \n | \n\n \n \n \n patient, code\n \n \n , patient+code\n \n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n Provenance:target\n \n | \n\n \n\n \n -\n \n | \n
| \n Goal\n | \n\n \n\n \n\n \n \n \n \n \n •US Core Goal Profile \n \n \n \n | \n\n \n \n \n description, lifecycle-status, patient, target-date\n \n \n , patient+description, patient+target-date, patient+lifecycle-status\n \n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n Provenance:target\n \n | \n\n \n\n \n -\n \n | \n
| \n HealthcareService\n | \n\n \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n
| \n Immunization\n | \n\n \n\n \n\n \n \n \n \n \n •US Core Immunization Profile \n \n \n \n | \n\n \n \n \n date, patient, status\n \n \n , patient+date, patient+status\n \n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n Provenance:target\n \n | \n\n \n\n \n -\n \n | \n
| \n Location\n | \n\n \n\n \n\n \n \n \n \n \n •US Core Location Profile \n \n \n \n | \n\n \n \n \n address, address-city, address-postalcode, address-state, name\n \n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n
| \n Medication\n | \n\n \n\n \n\n \n \n \n \n \n •US Core Medication Profile \n \n \n \n | \n\n \n \n \n -\n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n
| \n MedicationDispense\n | \n\n \n\n \n\n \n \n \n \n \n •US Core MedicationDispense Profile \n \n \n \n | \n\n \n \n \n patient, status, type\n \n \n , patient+status+type, patient+status\n \n \n | \n\n \n\n \n MedicationDispense:medication\n \n | \n\n \n\n \n Provenance:target\n \n | \n\n \n\n \n -\n \n | \n
| \n MedicationRequest\n | \n\n \n\n \n\n \n \n \n \n \n •US Core MedicationRequest Profile \n \n \n \n | \n\n \n \n \n authoredon, encounter, intent, patient, status\n \n \n , patient+intent+authoredon, patient+intent+encounter, patient+intent, patient+intent+status\n \n \n | \n\n \n\n \n MedicationRequest:medication\n \n | \n\n \n\n \n Provenance:target\n \n | \n\n \n\n \n -\n \n | \n
| \n Observation\n | \n\n \n\n \n\n \n \n \n \n \n •US Core Observation ADI Documentation Profile \n \n \n \n \n \n •US Core Laboratory Result Observation Profile \n \n \n \n \n \n •US Core Observation Pregnancy Status Profile \n \n \n \n \n \n •US Core Observation Pregnancy Intent Profile \n \n \n \n \n \n •US Core Observation Occupation Profile \n \n \n \n \n \n •US Core Respiratory Rate Profile \n \n \n \n \n \n •US Core Simple Observation Profile \n \n \n \n \n \n •US Core Treatment Intervention Preference Profile \n \n \n \n \n \n •US Core Care Experience Preference Profile \n \n \n \n \n \n •US Core Heart Rate Profile \n \n \n \n \n \n •US Core Body Temperature Profile \n \n \n \n \n \n •US Core Pediatric Weight for Height Observation Profile \n \n \n \n \n \n •US Core Pulse Oximetry Profile \n \n \n \n \n \n •US Core Smoking Status Observation Profile \n \n \n \n \n \n •US Core Observation Sexual Orientation Profile \n \n \n \n \n \n •US Core Head Circumference Profile \n \n \n \n \n \n •US Core Body Height Profile \n \n \n \n \n \n •US Core BMI Profile \n \n \n \n \n \n •US Core Observation Screening Assessment Profile \n \n \n \n \n \n •US Core Average Blood Pressure Profile \n \n \n \n \n \n •US Core Blood Pressure Profile \n \n \n \n \n \n •US Core Observation Clinical Result Profile \n \n \n \n \n \n •US Core Pediatric BMI for Age Observation Profile \n \n \n \n \n \n •US Core Pediatric Head Occipital Frontal Circumference Percentile Profile \n \n \n \n \n \n •US Core Body Weight Profile \n \n \n \n \n \n •US Core Vital Signs Profile \n \n \n \n | \n\n \n \n \n category, code, date, _lastUpdated, patient, status\n \n \n , patient+code+date, patient+category+_lastUpdated, patient+category+date, patient+category, patient+category+status, patient+code\n \n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n Provenance:target\n \n | \n\n \n\n \n -\n \n | \n
| \n Organization\n | \n\n \n\n \n\n \n \n \n \n \n •US Core Organization Profile \n \n \n \n | \n\n \n \n \n address, name\n \n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n
| \n Patient\n | \n\n \n\n \n\n \n \n \n \n \n •US Core Patient Profile \n \n \n \n | \n\n \n \n \n _id, birthdate, death-date, family, given, identifier, name\n \n \n , birthdate+name, birthdate+family, death-date+family\n \n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n Provenance:target\n \n | \n\n \n\n \n -\n \n | \n
| \n Practitioner\n | \n\n \n\n \n\n \n \n \n \n \n •US Core Practitioner Profile \n \n \n \n | \n\n \n \n \n _id, identifier, name\n \n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n
| \n PractitionerRole\n | \n\n \n\n \n\n \n \n \n \n \n •US Core PractitionerRole Profile \n \n \n \n | \n\n \n \n \n practitioner, specialty\n \n \n | \n\n \n\n \n PractitionerRole:endpoint\nPractitionerRole:practitioner\n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n
| \n Procedure\n | \n\n \n\n \n\n \n \n \n \n \n •US Core Procedure Profile \n \n \n \n | \n\n \n \n \n code, date, patient, status\n \n \n , patient+code+date, patient+date, patient+status\n \n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n Provenance:target\n \n | \n\n \n\n \n -\n \n | \n
| \n Provenance\n | \n\n \n\n \n\n \n \n \n \n \n •US Core Provenance Profile \n \n \n \n | \n\n \n \n \n -\n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n
| \n Questionnaire\n | \n\n \n\n \n\n \n \n \n \n \n •SDC Base Questionnaire Profile \n \n \n \n | \n\n \n \n \n -\n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n
| \n QuestionnaireResponse\n | \n\n \n\n \n\n \n \n \n \n \n •US Core QuestionnaireResponse Profile \n \n \n \n | \n\n \n \n \n _id, authored, patient, questionnaire, status\n \n \n , patient+questionnaire, patient+authored, patient+status\n \n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n Provenance:target\n \n | \n\n \n\n \n -\n \n | \n
| \n RelatedPerson\n | \n\n \n\n \n\n \n \n \n \n \n •US Core RelatedPerson Profile \n \n \n \n | \n\n \n \n \n _id, name, patient\n \n \n , patient+name\n \n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n Provenance:target\n \n | \n\n \n\n \n -\n \n | \n
| \n ServiceRequest\n | \n\n \n\n \n\n \n \n \n \n \n •US Core ServiceRequest Profile \n \n \n \n | \n\n \n \n \n _id, authored, category, code, patient, status\n \n \n , patient+code+authored, patient+category+authored, patient+category, patient+status, patient+code\n \n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n Provenance:target\n \n | \n\n \n\n \n -\n \n | \n
| \n Specimen\n | \n\n \n\n \n\n \n \n \n \n \n •US Core Specimen Profile \n \n \n \n | \n\n \n \n \n _id, patient\n \n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n
| \n ValueSet\n | \n\n \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n -\n \n | \n\n \n\n \n $expand\n \n | \n
Conformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/AllergyIntolerance {?_format=[mime-type]}\n \n PUT [base]/AllergyIntolerance/[id] {?_format=[mime-type]}\n \n PATCH [base]/AllergyIntolerance/[id] {?_format=[mime-type]}\n DELETE [base]/AllergyIntolerance/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning AllergyIntolerance resources matching a search query using:\n GET [base]/AllergyIntolerance/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a AllergyIntolerance resource using:\n GET [base]/AllergyIntolerance/[id]\n \n vread interaction returning a AllergyIntolerance resource using:\n GET [base]/AllergyIntolerance/[id]/_history/vid\n history-instance interaction returning a history of a AllergyIntolerance using:\n GET [base]/AllergyIntolerance/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of AllergyIntolerance resources using:\n GET [base]/AllergyIntolerance/_history{?[parameters]&_format=[mime-type]}\n GET [base]/AllergyIntolerance?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
\n| Conformance | \nParameter | \nType | \nExample | \n
|---|---|---|---|
| \n SHALL\n | \n\n patient\n | \n\n Reference\n | \n\n GET [base]/AllergyIntolerance?patient=[type]/[id]\n \n | \n
| \n SHOULD\n | \n\n patient+clinical-status\n | \n\n Reference+Token\n | \n\n GET [base]/AllergyIntolerance?patient=[type]/[id]&clinical-status=[system]|[code]\n | \n
The client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a id value and MAY provide both the Type and id values.
\nThe server SHALL support both.
\nConformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/CarePlan {?_format=[mime-type]}\n \n PUT [base]/CarePlan/[id] {?_format=[mime-type]}\n \n PATCH [base]/CarePlan/[id] {?_format=[mime-type]}\n DELETE [base]/CarePlan/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning CarePlan resources matching a search query using:\n GET [base]/CarePlan/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a CarePlan resource using:\n GET [base]/CarePlan/[id]\n \n vread interaction returning a CarePlan resource using:\n GET [base]/CarePlan/[id]/_history/vid\n history-instance interaction returning a history of a CarePlan using:\n GET [base]/CarePlan/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of CarePlan resources using:\n GET [base]/CarePlan/_history{?[parameters]&_format=[mime-type]}\n GET [base]/CarePlan?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
\n| Conformance | \nParameter | \nType | \nExample | \n
|---|---|---|---|
| \n SHOULD\n | \n\n patient+category+status\n | \n\n Reference+Token+Token\n | \n\n GET [base]/CarePlan?patient=[type]/[id]&category=[system]|[code]&status=[system]|[code]\n | \n
| \n SHALL\n | \n\n patient+category\n | \n\n Reference+Token\n | \n\n GET [base]/CarePlan?patient=[type]/[id]&category=[system]|[code]\n | \n
| \n SHOULD\n | \n\n patient+category+date\n | \n\n Reference+Token+Date/DateTime\n | \n\n GET [base]/CarePlan?patient=[type]/[id]&category=[system]|[code]&date=[dateTime]\n | \n
| \n SHOULD\n | \n\n patient+category+status+date\n | \n\n Reference+Token+Token+Date/DateTime\n | \n\n GET [base]/CarePlan?patient=[type]/[id]&category=[system]|[code]&status=[system]|[code]&date=[dateTime]\n | \n
The client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nA client SHALL provide a value precise to the second + time offset.
\nA server SHALL support a value precise to the second + time offset.
\nThe client SHALL provide at least a id value and MAY provide both the Type and id values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nConformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/CareTeam {?_format=[mime-type]}\n \n PUT [base]/CareTeam/[id] {?_format=[mime-type]}\n \n PATCH [base]/CareTeam/[id] {?_format=[mime-type]}\n DELETE [base]/CareTeam/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning CareTeam resources matching a search query using:\n GET [base]/CareTeam/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a CareTeam resource using:\n GET [base]/CareTeam/[id]\n \n vread interaction returning a CareTeam resource using:\n GET [base]/CareTeam/[id]/_history/vid\n history-instance interaction returning a history of a CareTeam using:\n GET [base]/CareTeam/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of CareTeam resources using:\n GET [base]/CareTeam/_history{?[parameters]&_format=[mime-type]}\n GET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:PractitionerRoleGET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:PractitionerGET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:PatientGET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:RelatedPersonGET [base]/CareTeam?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
\n| Conformance | \nParameter | \nType | \nExample | \n
|---|---|---|---|
| \n SHOULD\n | \n\n role\n | \n\n Token\n | \n\n GET [base]/CareTeam?role=[system]|[code]\n \n | \n
| \n SHALL\n | \n\n patient+status\n | \n\n Reference+Token\n | \n\n GET [base]/CareTeam?patient=[type]/[id]&status=[system]|[code]\n | \n
| \n SHOULD\n | \n\n patient+role\n | \n\n Reference+Token\n | \n\n GET [base]/CareTeam?patient=[type]/[id]&role=[system]|[code]\n | \n
The client SHALL provide at least a id value and MAY provide both the Type and id values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nConformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/Condition {?_format=[mime-type]}\n \n PUT [base]/Condition/[id] {?_format=[mime-type]}\n \n PATCH [base]/Condition/[id] {?_format=[mime-type]}\n DELETE [base]/Condition/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning Condition resources matching a search query using:\n GET [base]/Condition/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a Condition resource using:\n GET [base]/Condition/[id]\n \n vread interaction returning a Condition resource using:\n GET [base]/Condition/[id]/_history/vid\n history-instance interaction returning a history of a Condition using:\n GET [base]/Condition/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of Condition resources using:\n GET [base]/Condition/_history{?[parameters]&_format=[mime-type]}\n GET [base]/Condition?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
\n| Conformance | \nParameter | \nType | \nExample | \n
|---|---|---|---|
| \n SHALL\n | \n\n patient\n | \n\n Reference\n | \n\n GET [base]/Condition?patient=[type]/[id]\n \n | \n
| \n SHOULD\n | \n\n patient+clinical-status\n | \n\n Reference+Token\n | \n\n GET [base]/Condition?patient=[type]/[id]&clinical-status=[system]|[code]\n | \n
| \n SHOULD\n | \n\n patient+code\n | \n\n Reference+Token\n | \n\n GET [base]/Condition?patient=[type]/[id]&code=[system]|[code]\n | \n
| \n SHALL\n | \n\n patient+category\n | \n\n Reference+Token\n | \n\n GET [base]/Condition?patient=[type]/[id]&category=[system]|[code]\n | \n
| \n SHOULD\n | \n\n patient+abatement-date\n | \n\n Reference+Date/DateTime\n | \n\n GET [base]/Condition?patient=[type]/[id]&abatement-date=[dateTime]\n | \n
| \n SHOULD\n | \n\n patient+recorded-date\n | \n\n Reference+Date/DateTime\n | \n\n GET [base]/Condition?patient=[type]/[id]&recorded-date=[dateTime]\n | \n
| \n SHOULD\n | \n\n patient+_lastUpdated\n | \n\n Reference+Date/DateTime\n | \n\n GET [base]/Condition?patient=[type]/[id]&_lastUpdated=[dateTime]\n | \n
| \n SHOULD\n | \n\n patient+asserted-date\n | \n\n Reference+Date/DateTime\n | \n\n GET [base]/Condition?patient=[type]/[id]&asserted-date=[dateTime]\n | \n
| \n SHOULD\n | \n\n patient+category+clinical-status\n | \n\n Reference+Token+Token\n | \n\n GET [base]/Condition?patient=[type]/[id]&category=[system]|[code]&clinical-status=[system]|[code]\n | \n
| \n SHOULD\n | \n\n patient+onset-date\n | \n\n Reference+Date/DateTime\n | \n\n GET [base]/Condition?patient=[type]/[id]&onset-date=[dateTime]\n | \n
| \n SHOULD\n | \n\n patient+category+encounter\n | \n\n Reference+Token+Reference\n | \n\n GET [base]/Condition?patient=[type]/[id]&category=[system]|[code]&encounter=[type]/[id]\n | \n
A client SHALL provide a value precise to the second + time offset.
\nA server SHALL support a value precise to the second + time offset.
\nA client SHALL provide a value precise to the second + time offset.
\nA server SHALL support a value precise to the second + time offset.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a id value and MAY provide both the Type and id values.
\nThe server SHALL support both.
\nA client SHALL provide a value precise to the second + time offset.
\nA server SHALL support a value precise to the second + time offset.
\nThe client SHALL provide at least a id value and MAY provide both the Type and id values.
\nThe server SHALL support both.
\nA client SHALL provide a value precise to the second + time offset.
\nA server SHALL support a value precise to the second + time offset.
\nA server SHALL document the types of changes that can be detected using this parameter.
\nA client SHALL provide a value precise to the second + time offset.
\nA server SHALL support a value precise to the second + time offset.
\nConformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/Coverage {?_format=[mime-type]}\n \n PUT [base]/Coverage/[id] {?_format=[mime-type]}\n \n PATCH [base]/Coverage/[id] {?_format=[mime-type]}\n DELETE [base]/Coverage/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning Coverage resources matching a search query using:\n GET [base]/Coverage/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a Coverage resource using:\n GET [base]/Coverage/[id]\n \n vread interaction returning a Coverage resource using:\n GET [base]/Coverage/[id]/_history/vid\n history-instance interaction returning a history of a Coverage using:\n GET [base]/Coverage/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of Coverage resources using:\n GET [base]/Coverage/_history{?[parameters]&_format=[mime-type]}\n GET [base]/Coverage?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
\n| Conformance | \nParameter | \nType | \nExample | \n
|---|---|---|---|
| \n SHALL\n | \n\n patient\n | \n\n Reference\n | \n\n GET [base]/Coverage?patient=[type]/[id]\n \n | \n
The client SHALL provide at least a id value and MAY provide both the Type and id values.
\nThe server SHALL support both.
\nConformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/Device {?_format=[mime-type]}\n \n PUT [base]/Device/[id] {?_format=[mime-type]}\n \n PATCH [base]/Device/[id] {?_format=[mime-type]}\n DELETE [base]/Device/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning Device resources matching a search query using:\n GET [base]/Device/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a Device resource using:\n GET [base]/Device/[id]\n \n vread interaction returning a Device resource using:\n GET [base]/Device/[id]/_history/vid\n history-instance interaction returning a history of a Device using:\n GET [base]/Device/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of Device resources using:\n GET [base]/Device/_history{?[parameters]&_format=[mime-type]}\n GET [base]/Device?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
\n| Conformance | \nParameter | \nType | \nExample | \n
|---|---|---|---|
| \n SHALL\n | \n\n patient\n | \n\n Reference\n | \n\n GET [base]/Device?patient=[type]/[id]\n \n | \n
| \n SHOULD\n | \n\n patient+type\n | \n\n Reference+Token\n | \n\n GET [base]/Device?patient=[type]/[id]&type=[system]|[code]\n | \n
| \n SHOULD\n | \n\n patient+status\n | \n\n Reference+Token\n | \n\n GET [base]/Device?patient=[type]/[id]&status=[system]|[code]\n | \n
The client SHALL provide at least a id value and MAY provide both the Type and id values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nConformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/DiagnosticReport {?_format=[mime-type]}\n \n PUT [base]/DiagnosticReport/[id] {?_format=[mime-type]}\n \n PATCH [base]/DiagnosticReport/[id] {?_format=[mime-type]}\n DELETE [base]/DiagnosticReport/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning DiagnosticReport resources matching a search query using:\n GET [base]/DiagnosticReport/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a DiagnosticReport resource using:\n GET [base]/DiagnosticReport/[id]\n \n vread interaction returning a DiagnosticReport resource using:\n GET [base]/DiagnosticReport/[id]/_history/vid\n history-instance interaction returning a history of a DiagnosticReport using:\n GET [base]/DiagnosticReport/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of DiagnosticReport resources using:\n GET [base]/DiagnosticReport/_history{?[parameters]&_format=[mime-type]}\n GET [base]/DiagnosticReport?[parameter=value]&_revinclude=Provenance:target\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \ncreate
\nThis conformance expectation applies only to the US Core DiagnosticReport Profile for Report and Note exchange profile. The conformance expectation for the US Core DiagnosticReport Profile for Laboratory Results Reporting is MAY.
\n
Search Parameter Requirements (When Used Alone or in Combination):
\n| Conformance | \nParameter | \nType | \nExample | \n
|---|---|---|---|
| \n SHALL\n | \n\n patient\n | \n\n Reference\n | \n\n GET [base]/DiagnosticReport?patient=[type]/[id]\n \n | \n
| \n SHOULD\n | \n\n patient+code+date\n | \n\n Reference+Token+Date/DateTime\n | \n\n GET [base]/DiagnosticReport?patient=[type]/[id]&code=[system]|[code]&date=[dateTime]\n | \n
| \n SHOULD\n | \n\n patient+category+_lastUpdated\n | \n\n Reference+Token+Date/DateTime\n | \n\n GET [base]/DiagnosticReport?patient=[type]/[id]&category=[system]|[code]&_lastUpdated=[dateTime]\n | \n
| \n SHALL\n | \n\n patient+category+date\n | \n\n Reference+Token+Date/DateTime\n | \n\n GET [base]/DiagnosticReport?patient=[type]/[id]&category=[system]|[code]&date=[dateTime]\n | \n
| \n SHALL\n | \n\n patient+category\n | \n\n Reference+Token\n | \n\n GET [base]/DiagnosticReport?patient=[type]/[id]&category=[system]|[code]\n | \n
| \n SHOULD\n | \n\n patient+status\n | \n\n Reference+Token\n | \n\n GET [base]/DiagnosticReport?patient=[type]/[id]&status=[system]|[code]\n | \n
| \n SHALL\n | \n\n patient+code\n | \n\n Reference+Token\n | \n\n GET [base]/DiagnosticReport?patient=[type]/[id]&code=[system]|[code]\n | \n
The client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nA client SHALL provide a value precise to the second + time offset.
\nA server SHALL support a value precise to the second + time offset.
\nA server SHALL document the types of changes that can be detected using this parameter.
\nA client SHALL provide a value precise to the second + time offset.
\nA server SHALL support a value precise to the second + time offset.
\nThe client SHALL provide at least a id value and MAY provide both the Type and id values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nConformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/DocumentReference {?_format=[mime-type]}\n \n PUT [base]/DocumentReference/[id] {?_format=[mime-type]}\n \n PATCH [base]/DocumentReference/[id] {?_format=[mime-type]}\n DELETE [base]/DocumentReference/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning DocumentReference resources matching a search query using:\n GET [base]/DocumentReference/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a DocumentReference resource using:\n GET [base]/DocumentReference/[id]\n \n vread interaction returning a DocumentReference resource using:\n GET [base]/DocumentReference/[id]/_history/vid\n history-instance interaction returning a history of a DocumentReference using:\n GET [base]/DocumentReference/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of DocumentReference resources using:\n GET [base]/DocumentReference/_history{?[parameters]&_format=[mime-type]}\n GET [base]/DocumentReference?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
\n| Conformance | \nParameter | \nType | \nExample | \n
|---|---|---|---|
| \n SHALL\n | \n\n _id\n | \n\n Token\n | \n\n GET [base]/DocumentReference?_id=[id]\n \n | \n
| \n SHALL\n | \n\n patient\n | \n\n Reference\n | \n\n GET [base]/DocumentReference?patient=[type]/[id]\n \n | \n
| \n SHALL\n | \n\n patient+type\n | \n\n Reference+Token\n | \n\n GET [base]/DocumentReference?patient=[type]/[id]&type=[system]|[code]\n | \n
| \n SHALL\n | \n\n patient+category+date\n | \n\n Reference+Token+Date/DateTime\n | \n\n GET [base]/DocumentReference?patient=[type]/[id]&category=[system]|[code]&date=[dateTime]\n | \n
| \n SHALL\n | \n\n patient+category\n | \n\n Reference+Token\n | \n\n GET [base]/DocumentReference?patient=[type]/[id]&category=[system]|[code]\n | \n
| \n SHOULD\n | \n\n patient+type+period\n | \n\n Reference+Token+Date/DateTime\n | \n\n GET [base]/DocumentReference?patient=[type]/[id]&type=[system]|[code]&period=[dateTime]\n | \n
| \n SHOULD\n | \n\n patient+status\n | \n\n Reference+Token\n | \n\n GET [base]/DocumentReference?patient=[type]/[id]&status=[system]|[code]\n | \n
The client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nA client SHALL provide a value precise to the second + time offset.
\nA server SHALL support a value precise to the second + time offset.
\nThe client SHALL provide at least a id value and MAY provide both the Type and id values.
\nThe server SHALL support both.
\nA client SHALL provide a value precise to the second + time offset.
\nA server SHALL support a value precise to the second + time offset.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nFHIR Operations:
\n \n\n$docref\n \n \n\n \n \n \n\n
$docref:\nA server SHALL be capable of responding to a $docref operation and capable of returning at least a reference to a generated CCD document, if available. MAY provide references to other 'on-demand' and 'stable' documents (or 'delayed/deferred assembly') that meet the query parameters as well. If a context date range is supplied the server ** SHOULD** provide references to any document that falls within the date range. If no date range is supplied, then the server SHALL provide references to last or current document(s). SHOULD document what resources, if any, are returned as included resources
\n\n
GET [base]/DocumentReference/$docref?patient=[id]
Conformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/Encounter {?_format=[mime-type]}\n \n PUT [base]/Encounter/[id] {?_format=[mime-type]}\n \n PATCH [base]/Encounter/[id] {?_format=[mime-type]}\n DELETE [base]/Encounter/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning Encounter resources matching a search query using:\n GET [base]/Encounter/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a Encounter resource using:\n GET [base]/Encounter/[id]\n \n vread interaction returning a Encounter resource using:\n GET [base]/Encounter/[id]/_history/vid\n history-instance interaction returning a history of a Encounter using:\n GET [base]/Encounter/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of Encounter resources using:\n GET [base]/Encounter/_history{?[parameters]&_format=[mime-type]}\n GET [base]/Encounter?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
\n| Conformance | \nParameter | \nType | \nExample | \n
|---|---|---|---|
| \n SHALL\n | \n\n _id\n | \n\n Token\n | \n\n GET [base]/Encounter?_id=[id]\n \n | \n
| \n SHOULD\n | \n\n identifier\n | \n\n Token\n | \n\n GET [base]/Encounter?identifier=[system]|[code]\n \n | \n
| \n SHALL\n | \n\n patient\n | \n\n Reference\n | \n\n GET [base]/Encounter?patient=[type]/[id]\n \n | \n
| \n SHOULD\n | \n\n patient+type\n | \n\n Reference+Token\n | \n\n GET [base]/Encounter?patient=[type]/[id]&type=[system]|[code]\n | \n
| \n SHOULD\n | \n\n class+patient\n | \n\n Token+Reference\n | \n\n GET [base]/Encounter?class=[system]|[code]&patient=[type]/[id]\n | \n
| \n SHOULD\n | \n\n patient+status\n | \n\n Reference+Token\n | \n\n GET [base]/Encounter?patient=[type]/[id]&status=[system]|[code]\n | \n
| \n SHOULD\n | \n\n patient+_lastUpdated\n | \n\n Reference+Date/DateTime\n | \n\n GET [base]/Encounter?patient=[type]/[id]&_lastUpdated=[dateTime]\n | \n
| \n SHOULD\n | \n\n patient+location\n | \n\n Reference+Reference\n | \n\n GET [base]/Encounter?patient=[type]/[id]&location=[type]/[id]\n | \n
| \n SHALL\n | \n\n date+patient\n | \n\n Date/DateTime+Reference\n | \n\n GET [base]/Encounter?date=[dateTime]&patient=[type]/[id]\n | \n
| \n SHOULD\n | \n\n patient+discharge-disposition\n | \n\n Reference+Token\n | \n\n GET [base]/Encounter?patient=[type]/[id]&discharge-disposition=[system]|[code]\n | \n
The client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nA client SHALL provide a value precise to the second + time offset.
\nA server SHALL support a value precise to the second + time offset.
\nA server SHALL document the types of changes that can be detected using this parameter.
\nA client SHALL provide a value precise to the second + time offset.
\nA server SHALL support a value precise to the second + time offset.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a id value and MAY provide both the Type and id values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a id value and MAY provide both the Type and id values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nConformance Expectation: SHALL
\n \nResource Specific Documentation:
\n\n\n \n\n \n \n\nThe Endpoint Resource is a Must Support referenced resource when using the US Core PractitionerRole Profile.
\n
\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/Endpoint {?_format=[mime-type]}\n \n PUT [base]/Endpoint/[id] {?_format=[mime-type]}\n \n PATCH [base]/Endpoint/[id] {?_format=[mime-type]}\n DELETE [base]/Endpoint/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning Endpoint resources matching a search query using:\n GET [base]/Endpoint/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a Endpoint resource using:\n GET [base]/Endpoint/[id]\n \n vread interaction returning a Endpoint resource using:\n GET [base]/Endpoint/[id]/_history/vid\n history-instance interaction returning a history of a Endpoint using:\n GET [base]/Endpoint/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of Endpoint resources using:\n GET [base]/Endpoint/_history{?[parameters]&_format=[mime-type]}\n Conformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/FamilyMemberHistory {?_format=[mime-type]}\n \n PUT [base]/FamilyMemberHistory/[id] {?_format=[mime-type]}\n \n PATCH [base]/FamilyMemberHistory/[id] {?_format=[mime-type]}\n DELETE [base]/FamilyMemberHistory/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning FamilyMemberHistory resources matching a search query using:\n GET [base]/FamilyMemberHistory/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a FamilyMemberHistory resource using:\n GET [base]/FamilyMemberHistory/[id]\n \n vread interaction returning a FamilyMemberHistory resource using:\n GET [base]/FamilyMemberHistory/[id]/_history/vid\n history-instance interaction returning a history of a FamilyMemberHistory using:\n GET [base]/FamilyMemberHistory/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of FamilyMemberHistory resources using:\n GET [base]/FamilyMemberHistory/_history{?[parameters]&_format=[mime-type]}\n GET [base]/FamilyMemberHistory?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
\n| Conformance | \nParameter | \nType | \nExample | \n
|---|---|---|---|
| \n SHALL\n | \n\n patient\n | \n\n Reference\n | \n\n GET [base]/FamilyMemberHistory?patient=[type]/[id]\n \n | \n
| \n SHOULD\n | \n\n patient+code\n | \n\n Reference+Token\n | \n\n GET [base]/FamilyMemberHistory?patient=[type]/[id]&code=[system]|[code]\n | \n
The client SHALL provide at least a id value and MAY provide both the Type and id values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nConformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/Goal {?_format=[mime-type]}\n \n PUT [base]/Goal/[id] {?_format=[mime-type]}\n \n PATCH [base]/Goal/[id] {?_format=[mime-type]}\n DELETE [base]/Goal/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning Goal resources matching a search query using:\n GET [base]/Goal/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a Goal resource using:\n GET [base]/Goal/[id]\n \n vread interaction returning a Goal resource using:\n GET [base]/Goal/[id]/_history/vid\n history-instance interaction returning a history of a Goal using:\n GET [base]/Goal/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of Goal resources using:\n GET [base]/Goal/_history{?[parameters]&_format=[mime-type]}\n GET [base]/Goal?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
\n| Conformance | \nParameter | \nType | \nExample | \n
|---|---|---|---|
| \n SHALL\n | \n\n patient\n | \n\n Reference\n | \n\n GET [base]/Goal?patient=[type]/[id]\n \n | \n
| \n SHOULD\n | \n\n patient+description\n | \n\n Reference+Token\n | \n\n GET [base]/Goal?patient=[type]/[id]&description=[system]|[code]\n | \n
| \n SHOULD\n | \n\n patient+target-date\n | \n\n Reference+Date/DateTime\n | \n\n GET [base]/Goal?patient=[type]/[id]&target-date=[dateTime]\n | \n
| \n SHOULD\n | \n\n patient+lifecycle-status\n | \n\n Reference+Token\n | \n\n GET [base]/Goal?patient=[type]/[id]&lifecycle-status=[system]|[code]\n | \n
The client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a id value and MAY provide both the Type and id values.
\nThe server SHALL support both.
\nA client SHALL provide a value precise to the day.
\nA server SHALL support a value a value precise to the day.
\nConformance Expectation: MAY
\n \nResource Specific Documentation:
\n\n\n \n\n \n \n\nThe HealthcareService Resource is a referenced resource when using the US Core PractitionerRole Profile and subject to constraint us-core-13: \"SHALL have a practitioner, an organization, a healthcare service, or a location.\"
\n
\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/HealthcareService {?_format=[mime-type]}\n \n PUT [base]/HealthcareService/[id] {?_format=[mime-type]}\n \n PATCH [base]/HealthcareService/[id] {?_format=[mime-type]}\n DELETE [base]/HealthcareService/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning HealthcareService resources matching a search query using:\n GET [base]/HealthcareService/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a HealthcareService resource using:\n GET [base]/HealthcareService/[id]\n \n vread interaction returning a HealthcareService resource using:\n GET [base]/HealthcareService/[id]/_history/vid\n history-instance interaction returning a history of a HealthcareService using:\n GET [base]/HealthcareService/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of HealthcareService resources using:\n GET [base]/HealthcareService/_history{?[parameters]&_format=[mime-type]}\n Conformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/Immunization {?_format=[mime-type]}\n \n PUT [base]/Immunization/[id] {?_format=[mime-type]}\n \n PATCH [base]/Immunization/[id] {?_format=[mime-type]}\n DELETE [base]/Immunization/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning Immunization resources matching a search query using:\n GET [base]/Immunization/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a Immunization resource using:\n GET [base]/Immunization/[id]\n \n vread interaction returning a Immunization resource using:\n GET [base]/Immunization/[id]/_history/vid\n history-instance interaction returning a history of a Immunization using:\n GET [base]/Immunization/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of Immunization resources using:\n GET [base]/Immunization/_history{?[parameters]&_format=[mime-type]}\n GET [base]/Immunization?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
\n| Conformance | \nParameter | \nType | \nExample | \n
|---|---|---|---|
| \n SHALL\n | \n\n patient\n | \n\n Reference\n | \n\n GET [base]/Immunization?patient=[type]/[id]\n \n | \n
| \n SHOULD\n | \n\n patient+date\n | \n\n Reference+Date/DateTime\n | \n\n GET [base]/Immunization?patient=[type]/[id]&date=[dateTime]\n | \n
| \n SHOULD\n | \n\n patient+status\n | \n\n Reference+Token\n | \n\n GET [base]/Immunization?patient=[type]/[id]&status=[system]|[code]\n | \n
A client SHALL provide a value precise to the second + time offset.
\nA server SHALL support a value precise to the second + time offset.
\nThe client SHALL provide at least a id value and MAY provide both the Type and id values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nConformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/Location {?_format=[mime-type]}\n \n PUT [base]/Location/[id] {?_format=[mime-type]}\n \n PATCH [base]/Location/[id] {?_format=[mime-type]}\n DELETE [base]/Location/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning Location resources matching a search query using:\n GET [base]/Location/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a Location resource using:\n GET [base]/Location/[id]\n \n vread interaction returning a Location resource using:\n GET [base]/Location/[id]/_history/vid\n history-instance interaction returning a history of a Location using:\n GET [base]/Location/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of Location resources using:\n GET [base]/Location/_history{?[parameters]&_format=[mime-type]}\n Search Parameter Requirements (When Used Alone or in Combination):
\n| Conformance | \nParameter | \nType | \nExample | \n
|---|---|---|---|
| \n SHALL\n | \n\n address\n | \n\n String\n | \n\n GET [base]/Location?address=[address]\n \n | \n
| \n SHOULD\n | \n\n address-city\n | \n\n String\n | \n\n GET [base]/Location?address-city=[address-city]\n \n | \n
| \n SHOULD\n | \n\n address-postalcode\n | \n\n String\n | \n\n GET [base]/Location?address-postalcode=[address-postalcode]\n \n | \n
| \n SHOULD\n | \n\n address-state\n | \n\n String\n | \n\n GET [base]/Location?address-state=[address-state]\n \n | \n
| \n SHALL\n | \n\n name\n | \n\n String\n | \n\n GET [base]/Location?name=[name]\n \n | \n
Conformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/Medication {?_format=[mime-type]}\n \n PUT [base]/Medication/[id] {?_format=[mime-type]}\n \n PATCH [base]/Medication/[id] {?_format=[mime-type]}\n DELETE [base]/Medication/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning Medication resources matching a search query using:\n GET [base]/Medication/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a Medication resource using:\n GET [base]/Medication/[id]\n \n vread interaction returning a Medication resource using:\n GET [base]/Medication/[id]/_history/vid\n history-instance interaction returning a history of a Medication using:\n GET [base]/Medication/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of Medication resources using:\n GET [base]/Medication/_history{?[parameters]&_format=[mime-type]}\n Conformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/MedicationDispense {?_format=[mime-type]}\n \n PUT [base]/MedicationDispense/[id] {?_format=[mime-type]}\n \n PATCH [base]/MedicationDispense/[id] {?_format=[mime-type]}\n DELETE [base]/MedicationDispense/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning MedicationDispense resources matching a search query using:\n GET [base]/MedicationDispense/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a MedicationDispense resource using:\n GET [base]/MedicationDispense/[id]\n \n vread interaction returning a MedicationDispense resource using:\n GET [base]/MedicationDispense/[id]/_history/vid\n history-instance interaction returning a history of a MedicationDispense using:\n GET [base]/MedicationDispense/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of MedicationDispense resources using:\n GET [base]/MedicationDispense/_history{?[parameters]&_format=[mime-type]}\n GET [base]/MedicationDispense?[parameter=value]&_include=MedicationDispense:medicationGET [base]/MedicationDispense?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
\n| Conformance | \nParameter | \nType | \nExample | \n
|---|---|---|---|
| \n SHALL\n | \n\n patient\n | \n\n Reference\n | \n\n GET [base]/MedicationDispense?patient=[type]/[id]\n \n | \n
| \n SHOULD\n | \n\n patient+status+type\n | \n\n Reference+Token+Token\n | \n\n GET [base]/MedicationDispense?patient=[type]/[id]&status=[system]|[code]&type=[system]|[code]\n | \n
| \n SHOULD\n | \n\n patient+status\n | \n\n Reference+Token\n | \n\n GET [base]/MedicationDispense?patient=[type]/[id]&status=[system]|[code]\n | \n
The client SHALL provide at least a id value and MAY provide both the Type and id values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nConformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/MedicationRequest {?_format=[mime-type]}\n \n PUT [base]/MedicationRequest/[id] {?_format=[mime-type]}\n \n PATCH [base]/MedicationRequest/[id] {?_format=[mime-type]}\n DELETE [base]/MedicationRequest/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning MedicationRequest resources matching a search query using:\n GET [base]/MedicationRequest/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a MedicationRequest resource using:\n GET [base]/MedicationRequest/[id]\n \n vread interaction returning a MedicationRequest resource using:\n GET [base]/MedicationRequest/[id]/_history/vid\n history-instance interaction returning a history of a MedicationRequest using:\n GET [base]/MedicationRequest/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of MedicationRequest resources using:\n GET [base]/MedicationRequest/_history{?[parameters]&_format=[mime-type]}\n GET [base]/MedicationRequest?[parameter=value]&_include=MedicationRequest:medicationGET [base]/MedicationRequest?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
\n| Conformance | \nParameter | \nType | \nExample | \n
|---|---|---|---|
| \n SHOULD\n | \n\n patient+intent+authoredon\n | \n\n Reference+Token+Date/DateTime\n | \n\n GET [base]/MedicationRequest?patient=[type]/[id]&intent=[system]|[code]&authoredon=[dateTime]\n | \n
| \n SHOULD\n | \n\n patient+intent+encounter\n | \n\n Reference+Token+Reference\n | \n\n GET [base]/MedicationRequest?patient=[type]/[id]&intent=[system]|[code]&encounter=[type]/[id]\n | \n
| \n SHALL\n | \n\n patient+intent\n | \n\n Reference+Token\n | \n\n GET [base]/MedicationRequest?patient=[type]/[id]&intent=[system]|[code]\n | \n
| \n SHALL\n | \n\n patient+intent+status\n | \n\n Reference+Token+Token\n | \n\n GET [base]/MedicationRequest?patient=[type]/[id]&intent=[system]|[code]&status=[system]|[code]\n | \n
A client SHALL provide a value precise to the second + time offset.
\nA server SHALL support a value precise to the second + time offset.
\nThe client SHALL provide at least a id value and MAY provide both the Type and id values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a id value and MAY provide both the Type and id values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nConformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/Observation {?_format=[mime-type]}\n \n PUT [base]/Observation/[id] {?_format=[mime-type]}\n \n PATCH [base]/Observation/[id] {?_format=[mime-type]}\n DELETE [base]/Observation/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning Observation resources matching a search query using:\n GET [base]/Observation/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a Observation resource using:\n GET [base]/Observation/[id]\n \n vread interaction returning a Observation resource using:\n GET [base]/Observation/[id]/_history/vid\n history-instance interaction returning a history of a Observation using:\n GET [base]/Observation/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of Observation resources using:\n GET [base]/Observation/_history{?[parameters]&_format=[mime-type]}\n GET [base]/Observation?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
\n| Conformance | \nParameter | \nType | \nExample | \n
|---|---|---|---|
| \n SHOULD\n | \n\n patient+code+date\n | \n\n Reference+Token+Date/DateTime\n | \n\n GET [base]/Observation?patient=[type]/[id]&code=[system]|[code]&date=[dateTime]\n | \n
| \n SHOULD\n | \n\n patient+category+_lastUpdated\n | \n\n Reference+Token+Date/DateTime\n | \n\n GET [base]/Observation?patient=[type]/[id]&category=[system]|[code]&_lastUpdated=[dateTime]\n | \n
| \n SHALL\n | \n\n patient+category+date\n | \n\n Reference+Token+Date/DateTime\n | \n\n GET [base]/Observation?patient=[type]/[id]&category=[system]|[code]&date=[dateTime]\n | \n
| \n SHALL\n | \n\n patient+category\n | \n\n Reference+Token\n | \n\n GET [base]/Observation?patient=[type]/[id]&category=[system]|[code]\n | \n
| \n SHOULD\n | \n\n patient+category+status\n | \n\n Reference+Token+Token\n | \n\n GET [base]/Observation?patient=[type]/[id]&category=[system]|[code]&status=[system]|[code]\n | \n
| \n SHALL\n | \n\n patient+code\n | \n\n Reference+Token\n | \n\n GET [base]/Observation?patient=[type]/[id]&code=[system]|[code]\n | \n
The client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nA client SHALL provide a value precise to the second + time offset.
\nA server SHALL support a value precise to the second + time offset.
\nA server SHALL document the types of changes that can be detected using this parameter.
\nA client SHALL provide a value precise to the second + time offset.
\nA server SHALL support a value precise to the second + time offset.
\nThe client SHALL provide at least a id value and MAY provide both the Type and id values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nConformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/Organization {?_format=[mime-type]}\n \n PUT [base]/Organization/[id] {?_format=[mime-type]}\n \n PATCH [base]/Organization/[id] {?_format=[mime-type]}\n DELETE [base]/Organization/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning Organization resources matching a search query using:\n GET [base]/Organization/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a Organization resource using:\n GET [base]/Organization/[id]\n \n vread interaction returning a Organization resource using:\n GET [base]/Organization/[id]/_history/vid\n history-instance interaction returning a history of a Organization using:\n GET [base]/Organization/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of Organization resources using:\n GET [base]/Organization/_history{?[parameters]&_format=[mime-type]}\n Search Parameter Requirements (When Used Alone or in Combination):
\n| Conformance | \nParameter | \nType | \nExample | \n
|---|---|---|---|
| \n SHALL\n | \n\n address\n | \n\n String\n | \n\n GET [base]/Organization?address=[address]\n \n | \n
| \n SHALL\n | \n\n name\n | \n\n String\n | \n\n GET [base]/Organization?name=[name]\n \n | \n
Conformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/Patient {?_format=[mime-type]}\n \n PUT [base]/Patient/[id] {?_format=[mime-type]}\n \n PATCH [base]/Patient/[id] {?_format=[mime-type]}\n DELETE [base]/Patient/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning Patient resources matching a search query using:\n GET [base]/Patient/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a Patient resource using:\n GET [base]/Patient/[id]\n \n vread interaction returning a Patient resource using:\n GET [base]/Patient/[id]/_history/vid\n history-instance interaction returning a history of a Patient using:\n GET [base]/Patient/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of Patient resources using:\n GET [base]/Patient/_history{?[parameters]&_format=[mime-type]}\n GET [base]/Patient?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
\n| Conformance | \nParameter | \nType | \nExample | \n
|---|---|---|---|
| \n SHALL\n | \n\n _id\n | \n\n Token\n | \n\n GET [base]/Patient?_id=[id]\n \n | \n
| \n SHALL\n | \n\n identifier\n | \n\n Token\n | \n\n GET [base]/Patient?identifier=[system]|[code]\n \n | \n
| \n SHALL\n | \n\n name\n | \n\n String\n | \n\n GET [base]/Patient?name=[name]\n \n | \n
| \n SHALL\n | \n\n birthdate+name\n | \n\n Date/DateTime+String\n | \n\n GET [base]/Patient?birthdate=[dateTime]&name=[name]\n | \n
| \n SHOULD\n | \n\n birthdate+family\n | \n\n Date/DateTime+String\n | \n\n GET [base]/Patient?birthdate=[dateTime]&family=[family]\n | \n
| \n SHOULD\n | \n\n death-date+family\n | \n\n Date/DateTime+String\n | \n\n GET [base]/Patient?death-date=[dateTime]&family=[family]\n | \n
A client SHALL provide a value precise to the day.
\nA server SHALL support a value a value precise to the day.
\nA client SHALL provide a value precise to the day.
\nA server SHALL support a value a value precise to the day.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nConformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/Practitioner {?_format=[mime-type]}\n \n PUT [base]/Practitioner/[id] {?_format=[mime-type]}\n \n PATCH [base]/Practitioner/[id] {?_format=[mime-type]}\n DELETE [base]/Practitioner/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning Practitioner resources matching a search query using:\n GET [base]/Practitioner/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a Practitioner resource using:\n GET [base]/Practitioner/[id]\n \n vread interaction returning a Practitioner resource using:\n GET [base]/Practitioner/[id]/_history/vid\n history-instance interaction returning a history of a Practitioner using:\n GET [base]/Practitioner/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of Practitioner resources using:\n GET [base]/Practitioner/_history{?[parameters]&_format=[mime-type]}\n Search Parameter Requirements (When Used Alone or in Combination):
\n| Conformance | \nParameter | \nType | \nExample | \n
|---|---|---|---|
| \n SHOULD\n | \n\n _id\n | \n\n Token\n | \n\n GET [base]/Practitioner?_id=[id]\n \n | \n
| \n SHALL\n | \n\n identifier\n | \n\n Token\n | \n\n GET [base]/Practitioner?identifier=[system]|[code]\n \n | \n
| \n SHALL\n | \n\n name\n | \n\n String\n | \n\n GET [base]/Practitioner?name=[name]\n \n | \n
The client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nConformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/PractitionerRole {?_format=[mime-type]}\n \n PUT [base]/PractitionerRole/[id] {?_format=[mime-type]}\n \n PATCH [base]/PractitionerRole/[id] {?_format=[mime-type]}\n DELETE [base]/PractitionerRole/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning PractitionerRole resources matching a search query using:\n GET [base]/PractitionerRole/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a PractitionerRole resource using:\n GET [base]/PractitionerRole/[id]\n \n vread interaction returning a PractitionerRole resource using:\n GET [base]/PractitionerRole/[id]/_history/vid\n history-instance interaction returning a history of a PractitionerRole using:\n GET [base]/PractitionerRole/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of PractitionerRole resources using:\n GET [base]/PractitionerRole/_history{?[parameters]&_format=[mime-type]}\n GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:endpointGET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:practitionerSearch Parameter Requirements (When Used Alone or in Combination):
\n| Conformance | \nParameter | \nType | \nExample | \n
|---|---|---|---|
| \n SHALL\n | \n\n practitioner\n | \n\n Reference\n | \n\n GET [base]/PractitionerRole?practitioner=[type]/[id]\n \n | \n
| \n SHALL\n | \n\n specialty\n | \n\n Token\n | \n\n GET [base]/PractitionerRole?specialty=[system]|[code]\n \n | \n
The client SHALL provide at least a id value and MAY provide both the Type and id values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nConformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/Procedure {?_format=[mime-type]}\n \n PUT [base]/Procedure/[id] {?_format=[mime-type]}\n \n PATCH [base]/Procedure/[id] {?_format=[mime-type]}\n DELETE [base]/Procedure/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning Procedure resources matching a search query using:\n GET [base]/Procedure/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a Procedure resource using:\n GET [base]/Procedure/[id]\n \n vread interaction returning a Procedure resource using:\n GET [base]/Procedure/[id]/_history/vid\n history-instance interaction returning a history of a Procedure using:\n GET [base]/Procedure/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of Procedure resources using:\n GET [base]/Procedure/_history{?[parameters]&_format=[mime-type]}\n GET [base]/Procedure?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
\n| Conformance | \nParameter | \nType | \nExample | \n
|---|---|---|---|
| \n SHALL\n | \n\n patient\n | \n\n Reference\n | \n\n GET [base]/Procedure?patient=[type]/[id]\n \n | \n
| \n SHOULD\n | \n\n patient+code+date\n | \n\n Reference+Token+Date/DateTime\n | \n\n GET [base]/Procedure?patient=[type]/[id]&code=[system]|[code]&date=[dateTime]\n | \n
| \n SHALL\n | \n\n patient+date\n | \n\n Reference+Date/DateTime\n | \n\n GET [base]/Procedure?patient=[type]/[id]&date=[dateTime]\n | \n
| \n SHOULD\n | \n\n patient+status\n | \n\n Reference+Token\n | \n\n GET [base]/Procedure?patient=[type]/[id]&status=[system]|[code]\n | \n
The client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nA client SHALL provide a value precise to the second + time offset.
\nA server SHALL support a value precise to the second + time offset.
\nThe client SHALL provide at least a id value and MAY provide both the Type and id values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nConformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/Provenance {?_format=[mime-type]}\n \n PUT [base]/Provenance/[id] {?_format=[mime-type]}\n \n PATCH [base]/Provenance/[id] {?_format=[mime-type]}\n DELETE [base]/Provenance/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning Provenance resources matching a search query using:\n GET [base]/Provenance/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a Provenance resource using:\n GET [base]/Provenance/[id]\n \n vread interaction returning a Provenance resource using:\n GET [base]/Provenance/[id]/_history/vid\n history-instance interaction returning a history of a Provenance using:\n GET [base]/Provenance/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of Provenance resources using:\n GET [base]/Provenance/_history{?[parameters]&_format=[mime-type]}\n Conformance Expectation: SHOULD
\n \nResource Specific Documentation:
\n\n\n \n\n \n\n
\n- US Core defines two ways to represent the questions and responses to screening and assessment instruments:\n
\n\n
\n- Observation: US Core Observation Screening Assessment Profile
\n- Questionnaire/QuestionnaireResponse: SDC Base Questionnaire/US Core QuestionnaireResponse Profile
\n- US Core Servers SHALL support US Core Observation Screening Assessment Profile and SHOULD support the SDC Base Questionnaire Profile/US Core QuestionnaireResponse Profile
\n
Supported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/Questionnaire {?_format=[mime-type]}\n \n PUT [base]/Questionnaire/[id] {?_format=[mime-type]}\n \n PATCH [base]/Questionnaire/[id] {?_format=[mime-type]}\n DELETE [base]/Questionnaire/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning Questionnaire resources matching a search query using:\n GET [base]/Questionnaire/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a Questionnaire resource using:\n GET [base]/Questionnaire/[id]\n \n vread interaction returning a Questionnaire resource using:\n GET [base]/Questionnaire/[id]/_history/vid\n history-instance interaction returning a history of a Questionnaire using:\n GET [base]/Questionnaire/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of Questionnaire resources using:\n GET [base]/Questionnaire/_history{?[parameters]&_format=[mime-type]}\n Conformance Expectation: SHOULD
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/QuestionnaireResponse {?_format=[mime-type]}\n \n PUT [base]/QuestionnaireResponse/[id] {?_format=[mime-type]}\n \n PATCH [base]/QuestionnaireResponse/[id] {?_format=[mime-type]}\n DELETE [base]/QuestionnaireResponse/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning QuestionnaireResponse resources matching a search query using:\n GET [base]/QuestionnaireResponse/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a QuestionnaireResponse resource using:\n GET [base]/QuestionnaireResponse/[id]\n \n vread interaction returning a QuestionnaireResponse resource using:\n GET [base]/QuestionnaireResponse/[id]/_history/vid\n history-instance interaction returning a history of a QuestionnaireResponse using:\n GET [base]/QuestionnaireResponse/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of QuestionnaireResponse resources using:\n GET [base]/QuestionnaireResponse/_history{?[parameters]&_format=[mime-type]}\n GET [base]/QuestionnaireResponse?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
\n| Conformance | \nParameter | \nType | \nExample | \n
|---|---|---|---|
| \n SHALL\n | \n\n _id\n | \n\n Token\n | \n\n GET [base]/QuestionnaireResponse?_id=[id]\n \n | \n
| \n SHALL\n | \n\n patient\n | \n\n Reference\n | \n\n GET [base]/QuestionnaireResponse?patient=[type]/[id]\n \n | \n
| \n SHOULD\n | \n\n patient+questionnaire\n | \n\n Reference+Reference\n | \n\n GET [base]/QuestionnaireResponse?patient=[type]/[id]&questionnaire=[type]/[id]\n | \n
| \n SHOULD\n | \n\n patient+authored\n | \n\n Reference+Date/DateTime\n | \n\n GET [base]/QuestionnaireResponse?patient=[type]/[id]&authored=[dateTime]\n | \n
| \n SHOULD\n | \n\n patient+status\n | \n\n Reference+Token\n | \n\n GET [base]/QuestionnaireResponse?patient=[type]/[id]&status=[system]|[code]\n | \n
A client SHALL provide a value precise to the second + time offset.
\nA server SHALL support a value precise to the second + time offset.
\nThe client SHALL provide at least a id value and MAY provide both the Type and id values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a id value and MAY provide both the Type and id values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nConformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/RelatedPerson {?_format=[mime-type]}\n \n PUT [base]/RelatedPerson/[id] {?_format=[mime-type]}\n \n PATCH [base]/RelatedPerson/[id] {?_format=[mime-type]}\n DELETE [base]/RelatedPerson/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning RelatedPerson resources matching a search query using:\n GET [base]/RelatedPerson/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a RelatedPerson resource using:\n GET [base]/RelatedPerson/[id]\n \n vread interaction returning a RelatedPerson resource using:\n GET [base]/RelatedPerson/[id]/_history/vid\n history-instance interaction returning a history of a RelatedPerson using:\n GET [base]/RelatedPerson/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of RelatedPerson resources using:\n GET [base]/RelatedPerson/_history{?[parameters]&_format=[mime-type]}\n GET [base]/RelatedPerson?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
\n| Conformance | \nParameter | \nType | \nExample | \n
|---|---|---|---|
| \n SHALL\n | \n\n _id\n | \n\n Token\n | \n\n GET [base]/RelatedPerson?_id=[id]\n \n | \n
| \n SHOULD\n | \n\n name\n | \n\n String\n | \n\n GET [base]/RelatedPerson?name=[name]\n \n | \n
| \n SHOULD\n | \n\n patient\n | \n\n Reference\n | \n\n GET [base]/RelatedPerson?patient=[type]/[id]\n \n | \n
| \n SHOULD\n | \n\n patient+name\n | \n\n Reference+String\n | \n\n GET [base]/RelatedPerson?patient=[type]/[id]&name=[name]\n | \n
The client SHALL provide at least a id value and MAY provide both the Type and id values.
\nThe server SHALL support both.
\nConformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/ServiceRequest {?_format=[mime-type]}\n \n PUT [base]/ServiceRequest/[id] {?_format=[mime-type]}\n \n PATCH [base]/ServiceRequest/[id] {?_format=[mime-type]}\n DELETE [base]/ServiceRequest/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning ServiceRequest resources matching a search query using:\n GET [base]/ServiceRequest/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a ServiceRequest resource using:\n GET [base]/ServiceRequest/[id]\n \n vread interaction returning a ServiceRequest resource using:\n GET [base]/ServiceRequest/[id]/_history/vid\n history-instance interaction returning a history of a ServiceRequest using:\n GET [base]/ServiceRequest/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of ServiceRequest resources using:\n GET [base]/ServiceRequest/_history{?[parameters]&_format=[mime-type]}\n GET [base]/ServiceRequest?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
\n| Conformance | \nParameter | \nType | \nExample | \n
|---|---|---|---|
| \n SHALL\n | \n\n _id\n | \n\n Token\n | \n\n GET [base]/ServiceRequest?_id=[id]\n \n | \n
| \n SHALL\n | \n\n patient\n | \n\n Reference\n | \n\n GET [base]/ServiceRequest?patient=[type]/[id]\n \n | \n
| \n SHOULD\n | \n\n patient+code+authored\n | \n\n Reference+Token+Date/DateTime\n | \n\n GET [base]/ServiceRequest?patient=[type]/[id]&code=[system]|[code]&authored=[dateTime]\n | \n
| \n SHALL\n | \n\n patient+category+authored\n | \n\n Reference+Token+Date/DateTime\n | \n\n GET [base]/ServiceRequest?patient=[type]/[id]&category=[system]|[code]&authored=[dateTime]\n | \n
| \n SHALL\n | \n\n patient+category\n | \n\n Reference+Token\n | \n\n GET [base]/ServiceRequest?patient=[type]/[id]&category=[system]|[code]\n | \n
| \n SHOULD\n | \n\n patient+status\n | \n\n Reference+Token\n | \n\n GET [base]/ServiceRequest?patient=[type]/[id]&status=[system]|[code]\n | \n
| \n SHALL\n | \n\n patient+code\n | \n\n Reference+Token\n | \n\n GET [base]/ServiceRequest?patient=[type]/[id]&code=[system]|[code]\n | \n
A client SHALL provide a value precise to the second + time offset.
\nA server SHALL support a value precise to the second + time offset.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a id value and MAY provide both the Type and id values.
\nThe server SHALL support both.
\nThe client SHALL provide at least a code value and MAY provide both the system and code values.
\nThe server SHALL support both.
\nConformance Expectation: SHALL
\n \n \n\n \n\n \nSupported Profiles:
\n\n \n\n \n\n \n\n \n
\n\n \nFHIR RESTful Interactions
\nSummary:
\nModify Criteria Details:
\nPOST [base]/Specimen {?_format=[mime-type]}\n \n PUT [base]/Specimen/[id] {?_format=[mime-type]}\n \n PATCH [base]/Specimen/[id] {?_format=[mime-type]}\n DELETE [base]/Specimen/[id]\n \n Fetch and Search Criteria Details:
\nsearch-type interaction returning Specimen resources matching a search query using:\n GET [base]/Specimen/[id]{?[parameters]{&_format=[mime-type]}}\n read interaction returning a Specimen resource using:\n GET [base]/Specimen/[id]\n \n vread interaction returning a Specimen resource using:\n GET [base]/Specimen/[id]/_history/vid\n history-instance interaction returning a history of a Specimen using:\n GET [base]/Specimen/[id]/_history{?[parameters]&_format=[mime-type]}\n history-type interaction returning the history of Specimen resources using:\n GET [base]/Specimen/_history{?[parameters]&_format=[mime-type]}\n Search Parameter Requirements (When Used Alone or in Combination):
\n| Conformance | \nParameter | \nType | \nExample | \n
|---|---|---|---|
| \n SHALL\n | \n\n _id\n | \n\n Token\n | \n\n GET [base]/Specimen?_id=[id]\n \n | \n
| \n SHOULD\n | \n\n patient\n | \n\n Reference\n | \n\n GET [base]/Specimen?patient=[type]/[id]\n \n | \n
Conformance Expectation: SHOULD
\n \n \n\n \n\n \n \n\n\n \n\n \n\n \n\n \n
\n\n \n \n\nFHIR Operations:
\n \n\n$expand\n \n \n\n \n \n \n\n
$expand:\nIf a server supports DocumentReference for creating, using, and sharing clinical notes, it SHOULD also support the
\ncontextandcontextdirectionparameters of the $expand operation to enable clients to determine the supported note and report types, as well as the supported read/write formats for notes on the server.