IG Test3 - Local Development build (v0.0.0). See the Directory of published versions
StructureDefinition-template-profile-on-profile
Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
Published on Wed Feb 15 00:00:00 PST 2017 as active by the Health eData Inc.
This profile builds on USCorePatientProfile
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | USCorePatientProfile | Template-Profile-on-Profile | |
![]() ![]() ![]() | S | 1..1 | Identifier | |
![]() ![]() ![]() ![]() | S | 1..1 | uri | Fixed Value: http://Healthedata1/IG-Template/patient-ids |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | USCorePatientProfile | Template-Profile-on-Profile |
![]() ![]() ![]() | Σ | 0..1 | string | Logical id of this artifact |
![]() ![]() ![]() | ΣI | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
![]() ![]() ![]() | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | I | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
![]() ![]() ![]() | SI | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race |
![]() ![]() ![]() | SI | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity |
![]() ![]() ![]() | SI | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex |
![]() ![]() ![]() | ?!I | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | SΣI | 1..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() ![]() | SΣI | 1..1 | uri | The namespace for the identifier value Fixed Value: http://Healthedata1/IG-Template/patient-ids |
![]() ![]() ![]() ![]() | SΣI | 1..1 | string | The value that is unique within the system. Example General: 123456 |
![]() ![]() ![]() ![]() | ΣI | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | ?!ΣI | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() ![]() | SΣI | 1..* | HumanName | A name associated with the patient us-core-8: Patient.name.given or Patient.name.family or both SHALL be present |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() | ?!ΣI | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) |
![]() ![]() ![]() ![]() | ΣI | 0..1 | string | Text representation of the full name |
![]() ![]() ![]() ![]() | SΣI | 0..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() | SΣI | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() | ΣI | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() | ΣI | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() | ΣI | 0..1 | Period | Time period when name was/is in use |
![]() ![]() ![]() | SΣI | 0..* | ContactPoint | A contact detail for the individual |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() | SΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
![]() ![]() ![]() ![]() | SΣI | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() | ?!SΣI | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
![]() ![]() ![]() ![]() | ΣI | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() | ΣI | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() | SΣI | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
![]() ![]() ![]() | SΣI | 0..1 | date | The date of birth for the individual |
![]() ![]() ![]() | ?!ΣI | 0..1 | Indicates if the individual is deceased or not | |
![]() ![]() ![]() ![]() | boolean | |||
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() | SΣI | 0..* | Address | An address for the individual |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() | ?!ΣI | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required) Example General: home |
![]() ![]() ![]() ![]() | ΣI | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General: both |
![]() ![]() ![]() ![]() | ΣI | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
![]() ![]() ![]() ![]() | SΣI | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
![]() ![]() ![]() ![]() | SΣI | 0..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() ![]() | ΣI | 0..1 | string | District name (aka county) Example General: Madison |
![]() ![]() ![]() ![]() | SΣI | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible) |
![]() ![]() ![]() ![]() | SΣI | 0..1 | string | US Zip Codes Example General: 9132 |
![]() ![]() ![]() ![]() | ΣI | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
![]() ![]() ![]() ![]() | SΣI | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-22T06:00:00-07:00","end":"2010-06-30T07:00:00-07:00"} |
![]() ![]() ![]() | I | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible) |
![]() ![]() ![]() | I | 0..1 | Whether patient is part of a multiple birth | |
![]() ![]() ![]() ![]() | boolean | |||
![]() ![]() ![]() ![]() | integer | |||
![]() ![]() ![]() | I | 0..* | Attachment | Image of the patient |
![]() ![]() ![]() | I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations |
![]() ![]() ![]() ![]() | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | I | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible) |
![]() ![]() ![]() ![]() | I | 0..1 | HumanName | A name associated with the contact person |
![]() ![]() ![]() ![]() | I | 0..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() ![]() | I | 0..1 | Address | Address for the contact person |
![]() ![]() ![]() ![]() | I | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
![]() ![]() ![]() ![]() | I | 0..1 | Reference(Organization) | Organization that is associated with the contact |
![]() ![]() ![]() ![]() | I | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient |
![]() ![]() ![]() | SI | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations |
![]() ![]() ![]() ![]() | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | SI | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) |
![]() ![]() ![]() ![]() | I | 0..1 | boolean | Language preference indicator |
![]() ![]() ![]() | I | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider |
![]() ![]() ![]() | ΣI | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record |
![]() ![]() ![]() | ?!ΣI | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations |
![]() ![]() ![]() ![]() | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | ΣI | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
![]() ![]() ![]() ![]() | ΣI | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required) |
![]() |
yet to be done: Xml template
// Template Profile on Profile { "resourceType" : "Patient", "id" : "<string>", // Logical id of this artifact "meta" : {Meta}, // C? Metadata about the resource "implicitRules" : "<uri>", // C? A set of rules under which this content was created "language" : "<code>", // C? Language of the resource content "text" : {Narrative}, // C? Text summary of the resource, for human interpretation "contained" : [{Resource}], // Contained, inline Resources "extension": [ { // C? Only One! US Core Race Extension "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race", Not handled yet: complex extension http://hl7.org/fhir/us/core/StructureDefinition/us-core-race }, { // C? Only One! US Core ethnicity Extension "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity", Not handled yet: complex extension http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity }, { // C? Only One! Extension "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex", "valueCode" : "<code>" // C? Value of extension } ], "identifier" : [{ // C? R! Only One! An identifier for this patient "extension": [ ], "use" : "<code>", // C? usual | official | temp | secondary | old (If known) "type" : {CodeableConcept}, // C? Description of identifier "system" : "http://Healthedata1/IG-Template/patient-ids", // C? R! "value" : "<string>", // C? R! The value that is unique within the system. "period" : {Period}, // C? Time period when id is/was valid for use "assigner" : {Reference(Organization)} // C? Organization that issued id (may be just text) }], "active" : <boolean>, // C? Whether this patient's record is in active use "name" : [{ // C? R! A name associated with the patient "extension": [ ], "use" : "<code>", // C? usual | official | temp | nickname | anonymous | old | maiden "text" : "<string>", // C? Text representation of the full name "family" : "<string>", // C? Family name (often called 'Surname') "given" : ["<string>"], // C? Given names (not always 'first'). Includes middle names "prefix" : ["<string>"], // C? Parts that come before the name "suffix" : ["<string>"], // C? Parts that come after the name "period" : {Period} // C? Time period when name was/is in use }], "telecom" : [{ // C? A contact detail for the individual "extension": [ ], "system" : "<code>", // C? R! phone | fax | email | pager | url | sms | other "value" : "<string>", // C? R! The actual contact point details "use" : "<code>", // C? home | work | temp | old | mobile - purpose of this contact point "rank" : "<positiveInt>", // C? Specify preferred order of use (1 = highest) "period" : {Period} // C? Time period when the contact point was/is in use }], "gender" : "<code>", // C? R! male | female | other | unknown "birthDate" : "<date>", // C? The date of birth for the individual // deceased[x]: Indicates if the individual is deceased or not. One of these 2: "deceasedBoolean" : <boolean>, // C? Indicates if the individual is deceased or not "deceasedDateTime" : "<dateTime>", // C? Indicates if the individual is deceased or not "address" : [{ // C? An address for the individual "extension": [ ], "use" : "<code>", // C? home | work | temp | old | billing - purpose of this address "type" : "<code>", // C? postal | physical | both "text" : "<string>", // C? Text representation of the address "line" : ["<string>"], // C? Street name, number, direction & P.O. Box etc. "city" : "<string>", // C? Name of city, town etc. "district" : "<string>", // C? District name (aka county) "state" : "<string>", // C? Sub-unit of country (abbreviations ok) "postalCode" : "<string>", // C? US Zip Codes "country" : "<string>", // C? Country (e.g. can be ISO 3166 2 or 3 letter code) "period" : {Period} // C? Time period when address was/is in use }], "maritalStatus" : {CodeableConcept}, // C? Marital (civil) status of a patient // multipleBirth[x]: Whether patient is part of a multiple birth. One of these 2: "multipleBirthBoolean" : <boolean>, // C? Whether patient is part of a multiple birth "multipleBirthInteger" : <integer>, // C? Whether patient is part of a multiple birth "photo" : [{Attachment}], // C? Image of the patient "contact" : [{ // C? A contact party (e.g. guardian, partner, friend) for the patient "extension": [ ], "relationship" : [{CodeableConcept}], // C? The kind of relationship "name" : {HumanName}, // C? A name associated with the contact person "telecom" : [{ContactPoint}], // C? A contact detail for the person "address" : {Address}, // C? Address for the contact person "gender" : "<code>", // C? male | female | other | unknown "organization" : {Reference(Organization)}, // C? Organization that is associated with the contact "period" : {Period}, // C? The period during which this contact person or organization is valid to be contacted relating to this patient }], "communication" : [{ // C? A language which may be used to communicate with the patient about his or her health "extension": [ ], "language" : {CodeableConcept}, // C? R! The language which can be used to communicate with the patient about his or her health "preferred" : <boolean>, // C? Language preference indicator }], "generalPractitioner" : [{Reference(Organization)}], // C? Patient's nominated primary care provider "managingOrganization" : {Reference(Organization)}, // C? Organization that is the custodian of the patient record "link" : [{ // C? Link to another patient resource that concerns the same actual person "extension": [ ], "other" : {Reference(Patient)}, // C? R! The other patient or related person resource that the link refers to "type" : "<code>", // C? R! replaced-by | replaces | refer | seealso }], }
Differential View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | USCorePatientProfile | Template-Profile-on-Profile | |
![]() ![]() ![]() | S | 1..1 | Identifier | |
![]() ![]() ![]() ![]() | S | 1..1 | uri | Fixed Value: http://Healthedata1/IG-Template/patient-ids |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | USCorePatientProfile | Template-Profile-on-Profile |
![]() ![]() ![]() | Σ | 0..1 | string | Logical id of this artifact |
![]() ![]() ![]() | ΣI | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
![]() ![]() ![]() | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | I | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
![]() ![]() ![]() | SI | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race |
![]() ![]() ![]() | SI | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity |
![]() ![]() ![]() | SI | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex |
![]() ![]() ![]() | ?!I | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | SΣI | 1..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() ![]() | SΣI | 1..1 | uri | The namespace for the identifier value Fixed Value: http://Healthedata1/IG-Template/patient-ids |
![]() ![]() ![]() ![]() | SΣI | 1..1 | string | The value that is unique within the system. Example General: 123456 |
![]() ![]() ![]() ![]() | ΣI | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | ?!ΣI | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() ![]() | SΣI | 1..* | HumanName | A name associated with the patient us-core-8: Patient.name.given or Patient.name.family or both SHALL be present |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() | ?!ΣI | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) |
![]() ![]() ![]() ![]() | ΣI | 0..1 | string | Text representation of the full name |
![]() ![]() ![]() ![]() | SΣI | 0..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() | SΣI | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() | ΣI | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() | ΣI | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() | ΣI | 0..1 | Period | Time period when name was/is in use |
![]() ![]() ![]() | SΣI | 0..* | ContactPoint | A contact detail for the individual |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() | SΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
![]() ![]() ![]() ![]() | SΣI | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() | ?!SΣI | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
![]() ![]() ![]() ![]() | ΣI | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() | ΣI | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() | SΣI | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
![]() ![]() ![]() | SΣI | 0..1 | date | The date of birth for the individual |
![]() ![]() ![]() | ?!ΣI | 0..1 | Indicates if the individual is deceased or not | |
![]() ![]() ![]() ![]() | boolean | |||
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() | SΣI | 0..* | Address | An address for the individual |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() | ?!ΣI | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required) Example General: home |
![]() ![]() ![]() ![]() | ΣI | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General: both |
![]() ![]() ![]() ![]() | ΣI | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
![]() ![]() ![]() ![]() | SΣI | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
![]() ![]() ![]() ![]() | SΣI | 0..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() ![]() | ΣI | 0..1 | string | District name (aka county) Example General: Madison |
![]() ![]() ![]() ![]() | SΣI | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible) |
![]() ![]() ![]() ![]() | SΣI | 0..1 | string | US Zip Codes Example General: 9132 |
![]() ![]() ![]() ![]() | ΣI | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
![]() ![]() ![]() ![]() | SΣI | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-22T06:00:00-07:00","end":"2010-06-30T07:00:00-07:00"} |
![]() ![]() ![]() | I | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible) |
![]() ![]() ![]() | I | 0..1 | Whether patient is part of a multiple birth | |
![]() ![]() ![]() ![]() | boolean | |||
![]() ![]() ![]() ![]() | integer | |||
![]() ![]() ![]() | I | 0..* | Attachment | Image of the patient |
![]() ![]() ![]() | I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations |
![]() ![]() ![]() ![]() | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | I | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible) |
![]() ![]() ![]() ![]() | I | 0..1 | HumanName | A name associated with the contact person |
![]() ![]() ![]() ![]() | I | 0..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() ![]() | I | 0..1 | Address | Address for the contact person |
![]() ![]() ![]() ![]() | I | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
![]() ![]() ![]() ![]() | I | 0..1 | Reference(Organization) | Organization that is associated with the contact |
![]() ![]() ![]() ![]() | I | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient |
![]() ![]() ![]() | SI | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations |
![]() ![]() ![]() ![]() | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | SI | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) |
![]() ![]() ![]() ![]() | I | 0..1 | boolean | Language preference indicator |
![]() ![]() ![]() | I | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider |
![]() ![]() ![]() | ΣI | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record |
![]() ![]() ![]() | ?!ΣI | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations |
![]() ![]() ![]() ![]() | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | ΣI | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
![]() ![]() ![]() ![]() | ΣI | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required) |
![]() |
XML Template
yet to be done: Xml template
JSON Template
// Template Profile on Profile { "resourceType" : "Patient", "id" : "<string>", // Logical id of this artifact "meta" : {Meta}, // C? Metadata about the resource "implicitRules" : "<uri>", // C? A set of rules under which this content was created "language" : "<code>", // C? Language of the resource content "text" : {Narrative}, // C? Text summary of the resource, for human interpretation "contained" : [{Resource}], // Contained, inline Resources "extension": [ { // C? Only One! US Core Race Extension "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race", Not handled yet: complex extension http://hl7.org/fhir/us/core/StructureDefinition/us-core-race }, { // C? Only One! US Core ethnicity Extension "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity", Not handled yet: complex extension http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity }, { // C? Only One! Extension "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex", "valueCode" : "<code>" // C? Value of extension } ], "identifier" : [{ // C? R! Only One! An identifier for this patient "extension": [ ], "use" : "<code>", // C? usual | official | temp | secondary | old (If known) "type" : {CodeableConcept}, // C? Description of identifier "system" : "http://Healthedata1/IG-Template/patient-ids", // C? R! "value" : "<string>", // C? R! The value that is unique within the system. "period" : {Period}, // C? Time period when id is/was valid for use "assigner" : {Reference(Organization)} // C? Organization that issued id (may be just text) }], "active" : <boolean>, // C? Whether this patient's record is in active use "name" : [{ // C? R! A name associated with the patient "extension": [ ], "use" : "<code>", // C? usual | official | temp | nickname | anonymous | old | maiden "text" : "<string>", // C? Text representation of the full name "family" : "<string>", // C? Family name (often called 'Surname') "given" : ["<string>"], // C? Given names (not always 'first'). Includes middle names "prefix" : ["<string>"], // C? Parts that come before the name "suffix" : ["<string>"], // C? Parts that come after the name "period" : {Period} // C? Time period when name was/is in use }], "telecom" : [{ // C? A contact detail for the individual "extension": [ ], "system" : "<code>", // C? R! phone | fax | email | pager | url | sms | other "value" : "<string>", // C? R! The actual contact point details "use" : "<code>", // C? home | work | temp | old | mobile - purpose of this contact point "rank" : "<positiveInt>", // C? Specify preferred order of use (1 = highest) "period" : {Period} // C? Time period when the contact point was/is in use }], "gender" : "<code>", // C? R! male | female | other | unknown "birthDate" : "<date>", // C? The date of birth for the individual // deceased[x]: Indicates if the individual is deceased or not. One of these 2: "deceasedBoolean" : <boolean>, // C? Indicates if the individual is deceased or not "deceasedDateTime" : "<dateTime>", // C? Indicates if the individual is deceased or not "address" : [{ // C? An address for the individual "extension": [ ], "use" : "<code>", // C? home | work | temp | old | billing - purpose of this address "type" : "<code>", // C? postal | physical | both "text" : "<string>", // C? Text representation of the address "line" : ["<string>"], // C? Street name, number, direction & P.O. Box etc. "city" : "<string>", // C? Name of city, town etc. "district" : "<string>", // C? District name (aka county) "state" : "<string>", // C? Sub-unit of country (abbreviations ok) "postalCode" : "<string>", // C? US Zip Codes "country" : "<string>", // C? Country (e.g. can be ISO 3166 2 or 3 letter code) "period" : {Period} // C? Time period when address was/is in use }], "maritalStatus" : {CodeableConcept}, // C? Marital (civil) status of a patient // multipleBirth[x]: Whether patient is part of a multiple birth. One of these 2: "multipleBirthBoolean" : <boolean>, // C? Whether patient is part of a multiple birth "multipleBirthInteger" : <integer>, // C? Whether patient is part of a multiple birth "photo" : [{Attachment}], // C? Image of the patient "contact" : [{ // C? A contact party (e.g. guardian, partner, friend) for the patient "extension": [ ], "relationship" : [{CodeableConcept}], // C? The kind of relationship "name" : {HumanName}, // C? A name associated with the contact person "telecom" : [{ContactPoint}], // C? A contact detail for the person "address" : {Address}, // C? Address for the contact person "gender" : "<code>", // C? male | female | other | unknown "organization" : {Reference(Organization)}, // C? Organization that is associated with the contact "period" : {Period}, // C? The period during which this contact person or organization is valid to be contacted relating to this patient }], "communication" : [{ // C? A language which may be used to communicate with the patient about his or her health "extension": [ ], "language" : {CodeableConcept}, // C? R! The language which can be used to communicate with the patient about his or her health "preferred" : <boolean>, // C? Language preference indicator }], "generalPractitioner" : [{Reference(Organization)}], // C? Patient's nominated primary care provider "managingOrganization" : {Reference(Organization)}, // C? Organization that is the custodian of the patient record "link" : [{ // C? Link to another patient resource that concerns the same actual person "extension": [ ], "other" : {Reference(Patient)}, // C? R! The other patient or related person resource that the link refers to "type" : "<code>", // C? R! replaced-by | replaces | refer | seealso }], }
See the Conformance requirements for a complete list of supported RESTful interactions for this IG.