CapabilityStatement.patchFormat

FHIR attribute (r4)

In the CapabilityStatement resource for FHIR r4 , the patchFormat attribute identifies the Patch formats supported

patchFormat (CapabilityStatement) description

Resource Type: CapabilityStatement

Attribute Name: patchFormat

Description: Patch formats supported

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

CapabilityStatement.patchFormat Example

"patchFormat": [
  "application/xml-patch+xml",
  "application/json-patch+json"
]

CapabilityStatement attributes

AttributeField is listTypeDescription

Description: Canonical identifier for this capability statement, represented as a URI (globally unique)

FHIR Version: r4

Attribute Type : uri

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"url": "urn:uuid:68D043B5-9ECF-4559-A57A-396E0D452311"

Learn more about the (CapabilityStatement) url FHIR attribute

Description: Business version of the capability statement

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"version": "20130510"

Learn more about the (CapabilityStatement) version FHIR attribute

Description: C? Name for this capability statement (computer friendly)

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"name": "ACME-EHR"

Learn more about the (CapabilityStatement) name FHIR attribute

Description: Name for this capability statement (human friendly)

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"title": "ACME EHR capability statement"

Learn more about the (CapabilityStatement) title FHIR attribute

Description: draft | active | retired | unknown

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"status": "draft"

Learn more about the (CapabilityStatement) status FHIR attribute

Description: For testing purposes, not real usage

FHIR Version: r4

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"experimental": true

Learn more about the (CapabilityStatement) experimental FHIR attribute

Description: Date last changed

FHIR Version: r4

Attribute Type : dateTime

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"date": "2012-01-04"

Learn more about the (CapabilityStatement) date FHIR attribute

Description: Name of the publisher (organization or individual)

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"publisher": "ACME Corporation"

Learn more about the (CapabilityStatement) publisher FHIR attribute

Description: Contact details for the publisher

FHIR Version: r4

Attribute Type : ContactDetail

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"contact": [
  {
    "name": "System Administrator",
    "telecom": [
      {
        "system": "email",
        "value": "wile@acme.org"
      }
    ]
  }
]

Learn more about the (CapabilityStatement) contact FHIR attribute

Description: C? Natural language description of the capability statement

FHIR Version: r4

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"description": "This is the FHIR capability statement for the main EHR at ACME for the private interface - it does not describe the public interface"

Learn more about the (CapabilityStatement) description FHIR attribute

Description: The context that the content is intended to support

FHIR Version: r4

Attribute Type : UsageContext

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"useContext": [
  {
    "code": {
      "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
      "code": "focus"
    },
    "valueCodeableConcept": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/variant-state",
          "code": "positive"
        }
      ]
    }
  }
]

Learn more about the (CapabilityStatement) useContext FHIR attribute

Description: Intended jurisdiction for capability statement (if applicable)

FHIR Version: r4

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"jurisdiction": [
  {
    "coding": [
      {
        "system": "urn:iso:std:iso:3166",
        "code": "US",
        "display": "United States of America (the)"
      }
    ]
  }
]

Learn more about the (CapabilityStatement) jurisdiction FHIR attribute

Description: Why this capability statement is defined

FHIR Version: r4

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"purpose": "Main EHR capability statement, published for contracting and operational support"

Learn more about the (CapabilityStatement) purpose FHIR attribute

Description: Use and/or publishing restrictions

FHIR Version: r4

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"copyright": "Copyright © Acme Healthcare and GoodCorp EHR Systems"

Learn more about the (CapabilityStatement) copyright FHIR attribute

Description: C? instance | capability | requirements

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"kind": "instance"

Learn more about the (CapabilityStatement) kind FHIR attribute

Description: Canonical URL of another capability statement this implements

FHIR Version: r4

Attribute Type : canonical(CapabilityStatement)

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"instantiates": [
  "http://ihe.org/fhir/CapabilityStatement/pixm-client"
]

Learn more about the (CapabilityStatement) instantiates FHIR attribute

Description: Canonical URL of another capability statement this adds to

FHIR Version: r4

Attribute Type : canonical(CapabilityStatement)

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"imports":

Learn more about the (CapabilityStatement) imports FHIR attribute

Description: C? Software that is covered by this capability statement

FHIR Version: r4

Attribute Type : Data Type

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"software": {
  "name": "EHR",
  "version": "0.00.020.2134",
  "releaseDate": "2012-01-04"
}

Learn more about the (CapabilityStatement) software FHIR attribute

Description: C? If this describes a specific instance

FHIR Version: r4

Attribute Type : Data Type

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"implementation": {
  "description": "main EHR at ACME",
  "url": "http://10.2.3.4/fhir"
}

Learn more about the (CapabilityStatement) implementation FHIR attribute

Description: FHIR Version the system supports

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"fhirVersion": "4.0.1"

Learn more about the (CapabilityStatement) fhirVersion FHIR attribute

Description: formats supported (xml | json | ttl | mime type)

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"format": [
  "xml",
  "json"
]

Learn more about the (CapabilityStatement) format FHIR attribute

Description: Patch formats supported

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"patchFormat": [
  "application/xml-patch+xml",
  "application/json-patch+json"
]

Learn more about the (CapabilityStatement) patchFormat FHIR attribute

Description: Implementation guides supported

FHIR Version: r4

Attribute Type : canonical(ImplementationGuide)

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"implementationGuide": [
  "http://hl7.org/fhir/us/lab"
]

Learn more about the (CapabilityStatement) implementationGuide FHIR attribute

Description: C? If the endpoint is a RESTful one

FHIR Version: r4

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"rest": [
  {
    "mode": "server",
    "documentation": "Main FHIR endpoint for acem health",
    "security": {
      "cors": true,
      "service": [
        {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
              "code": "SMART-on-FHIR"
            }
          ]
        }
      ],
      "description": "See Smart on FHIR documentation"
    },
    "resource": [
      {
        "type": "Patient",
        "profile": "http://registry.fhir.org/r4/StructureDefinition/7896271d-57f6-4231-89dc-dcc91eab2416",
        "supportedProfile": [
          "http://registry.fhir.org/r4/StructureDefinition/00ab9e7a-06c7-4f77-9234-4154ca1e3347"
        ],
        "documentation": "This server does not let the clients create identities.",
        "interaction": [
          {
            "code": "read"
          },
          {
            "code": "vread",
            "documentation": "Only supported for patient records since 12-Dec 2012"
          },
          {
            "code": "update"
          },
          {
            "code": "history-instance"
          },
          {
            "code": "create"
          },
          {
            "code": "history-type"
          }
        ],
        "versioning": "versioned-update",
        "readHistory": true,
        "updateCreate": false,
        "conditionalCreate": true,
        "conditionalRead": "full-support",
        "conditionalUpdate": false,
        "conditionalDelete": "not-supported",
        "searchInclude": [
          "Organization"
        ],
        "searchRevInclude": [
          "Person"
        ],
        "searchParam": [
          {
            "name": "identifier",
            "definition": "http://hl7.org/fhir/SearchParameter/Patient-identifier",
            "type": "token",
            "documentation": "Only supports search by institution MRN"
          },
          {
            "name": "general-practitioner",
            "definition": "http://hl7.org/fhir/SearchParameter/Patient-general-practitioner",
            "type": "reference"
          }
        ]
      }
    ],
    "interaction": [
      {
        "code": "transaction"
      },
      {
        "code": "history-system"
      }
    ],
    "compartment": [
      "http://hl7.org/fhir/CompartmentDefinition/patient"
    ]
  }
]

Learn more about the (CapabilityStatement) rest FHIR attribute

Description: C? If messaging is supported

FHIR Version: r4

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"messaging": [
  {
    "endpoint": [
      {
        "protocol": {
          "system": "http://terminology.hl7.org/CodeSystem/message-transport",
          "code": "mllp"
        },
        "address": "mllp:10.1.1.10:9234"
      }
    ],
    "reliableCache": 30,
    "documentation": "ADT A08 equivalent for external system notifications",
    "supportedMessage": [
      {
        "mode": "receiver",
        "definition": "MessageDefinition/example"
      }
    ]
  }
]

Learn more about the (CapabilityStatement) messaging FHIR attribute

Description: C? Document definition

FHIR Version: r4

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"document": [
  {
    "mode": "consumer",
    "documentation": "Basic rules for all documents in the EHR system",
    "profile": "http://fhir.hl7.org/base/Profilebc054d23-75e1-4dc6-aca5-838b6b1ac81d/_history/b5fdd9fc-b021-4ea1-911a-721a60663796"
  }
]

Learn more about the (CapabilityStatement) document FHIR attribute