Sachverhalt:
A. Der 1964 geborene O._ arbeitete von 1995 bis 2000 und wiederum seit 1. Januar 2001, nunmehr in einem Teilzeitpensum von 80 %, beim Restaurant X._. Ab 7. Mai 2001 blieb er aus gesundheitlichen Gründen der Arbeit fern. Am 8. November 2001 meldete er sich unter Hinweis auf eine Fibromyalgie bei der Invalidenversicherung zum Leistungsbezug an. Die IV-Stelle des Kantons Zürich holte u.a. eine polydisziplinäre Expertise der Medizinischen Abklärungsstelle am Spital Y._ (MEDAS) vom 6. Februar 2003 ein. Am 21. November 2003 reichte O._ bei der Invalidenversicherung eine Anmeldung zum Rentenbezug ein, worauf die IV-Stelle am 22. April 2004 die Ablehnung des Gesuchs verfügte. Am 24. Mai 2004 reichte der Versicherte hiegegen Einsprache ein. Die IV-Stelle liess O._ erneut stationär abklären, diesmal vom 18. bis 22. September 2006 im Zentrum für Medizinische Begutachtung, (ZMB; Expertise vom 12. Dezember 2006, ergänzt am 23. April 2007). Schliesslich erstattete Dr. med. S._, am 23. Januar 2008 ein psychiatrisches Gutachten. Der Versicherte reichte am 29. September 2008 eine Privatexpertise der Psychiaterin Frau Dr. med. P._, vom 21. Januar 2008 ein. Dr. med. S._, der schon vorgängig Kenntnis vom Privatgutachten gehabt hatte, hielt am 3. Februar 2008 an seiner Einschätzung fest. Am 10. Februar 2009 erstattete der Psychiater pract. med. D._ vom Regionalen Ärztlichen Dienst (RAD) einen Untersuchungsbericht. Mit Entscheid vom 11. Mai 2009 hiess die IV-Stelle die Einsprache gegen die Verfügung vom 22. April 2004 teilweise gut und eröffnete der Ausgleichskasse GastroSocial, dass bei O._ ab 1. Mai 2002 ein Invaliditätsgrad von 100 % bestehe. Am 20. November 2009 reichte die GastroSocial Pensionskasse ein psychiatrisches Privatgutachten ihres Vertrauensarztes Dr. med. C._, vom 18. November 2009 ein. Am 20. Januar 2010 erliess die IV-Stelle für den Zeitraum vom 1. Mai 2002 bis 30. November 2007 sowie ab 1. Dezember 2007 die entsprechenden Verfügungen über jeweils eine ganze Invalidenrente.
B. Die GastroSocial Pensionskasse reichte gegen die Verfügungen der IV-Stelle des Kantons Zürich vom 20. Januar 2010 Beschwerde beim Sozialversicherungsgericht des Kantons Zürich ein. Mit Verfügung vom 21. Mai 2010 wurde O._ zum Prozess beigeladen. Das Sozialversicherungsgericht wies die Beschwerde mit Entscheid vom 30. September 2011 ab.
C. Die GastroSocial Pensionskasse führt Beschwerde in öffentlich-rechtlichen Angelegenheiten mit den Rechtsbegehren, unter Aufhebung des vorinstanzlichen Entscheides und der vorangegangenen Verfügung sei eine Oberbegutachtung durchzuführen; gestützt auf deren Ergebnisse sei der Invaliditätsgrad neu zu bestimmen.
Die IV-Stelle und O._ lassen sich mit dem Antrag auf Abweisung der Beschwerde vernehmen. Das Bundesamt für Sozialversicherungen verzichtet auf eine Stellungnahme.
Erwägungen:
1. Die Beschwerde kann u.a. wegen Verletzung von Bundesrecht gemäss Art. 95 lit. a BGG erhoben werden. Die Feststellung des Sachverhalts kann nur gerügt werden, wenn sie offensichtlich unrichtig ist oder auf einer Rechtsverletzung im Sinne von Art. 95 beruht und wenn die Behebung des Mangels für den Ausgang des Verfahrens entscheidend sein kann (Art. 97 Abs. 1 BGG). Das Bundesgericht legt seinem Urteil den Sachverhalt zugrunde, den die Vorinstanz festgestellt hat (Art. 105 Abs. 1 BGG). Es kann die Sachverhaltsfeststellung der Vorinstanz von Amtes wegen berichtigen oder ergänzen, wenn sie offensichtlich unrichtig ist oder auf einer Rechtsverletzung im Sinne von Art. 95 beruht (Art. 105 Abs. 2 BGG). Das Bundesgericht wendet das Recht von Amtes wegen an (Art. 106 Abs. 1 BGG). Es ist somit weder an die in der Beschwerde geltend gemachten Argumente noch an die Erwägungen der Vorinstanz gebunden; es kann eine Beschwerde aus einem anderen als dem angerufenen Grund gutheissen und es kann sie mit einer von der Argumentation der Vorinstanz abweichenden Begründung abweisen (vgl. BGE 130 III 136 E. 1.4 S. 140).
2. Die Invaliditätsbemessung der Invalidenversicherung ist geeignet, die Leistungspflicht aus (obligatorischer) beruflicher Vorsorge in grundsätzlicher, zeitlicher und masslicher Hinsicht im Sinne von Art. 49 Abs. 4 ATSG (unmittelbar) zu berühren (vgl. Art. 23 ff. BVG). Die Organe der beruflichen Vorsorge sind daher zur Beschwerde gegen die Verfügung der IV-Stelle über den Rentenanspruch als solchen oder den Invaliditätsgrad berechtigt; ebenso ist der BVG-Versicherer grundsätzlich befugt, Beschwerde an das Bundesgericht gegen Entscheide kantonaler Gerichte in Streitigkeiten um eine Rente der Invalidenversicherung zu führen (BGE 132 V 1 E. 3.3.1 S. 5; vgl. Art. 89 Abs. 1 lit. b und c BGG sowie das Urteil 9C_987/2009 vom 27. Januar 2010).
3. Die Vorinstanz betrachtet die Verfügungen vom 20. Januar 2010 als Anfechtungsobjekt. Dies ist unzutreffend. Denn tatsächlich interessiert hier nur die Verfügung vom 22. April 2004, die - vorbehältlich einer prozessualen Revision (Art. 53 Abs. 1 ATSG) oder einer Wiedererwägung (Art. 53 Abs. 2 ATSG) - nicht durch eine andere Verfügung ersetzt werden kann. Vielmehr tritt der materielle Einspracheentscheid an die Stelle der angefochtenen Verfügung (KIESER, ATSG-Kommentar, 2. Aufl., Art. 52 ATSG Rz. 39). Gegen die Verfügung vom 22. April 2004 wurde am 24. Mai 2004 Einsprache erhoben. Gemäss den bis 30. Juni 2006 anwendbaren Bestimmungen des ATSG und des IVG hatte somit ein Einspracheentscheid und nicht eine erneute Verfügung zu ergehen. Tatsächlich hat die IV-Stelle denn auch am 11. Mai 2009 einen Einspracheentscheid erlassen. Dieser wurde jedoch - soweit ersichtlich - der Beschwerdeführerin nicht eröffnet. Zwar ist anzunehmen, dass diese zusammen mit den ihr am 22. September 2009 zugestellten Akten auch vom Einspracheentscheid Kenntnis erlangt hat. Tatsächlich war jedoch der Einspracheentscheid vom 11. Mai 2009 auch unvollständig; denn in Ziff. II/2 wurde festgehalten: "Die angeheftete neue Rentenverfügung bildet integrierenden Bestandteil des Einspracheentscheides." Eine Rentenverfügung wurde indessen nicht beigeheftet, sondern die entsprechenden Verfügungen wurden erst Monate später, am 20. Januar 2010, erstellt. Effektiv handelt es sich bei diesen "Verfügungen" nur um die konkreten Rentenberechnungen, und diese bilden integrierenden Bestandteil des Einspracheentscheides, der faktisch an zwei Zeitpunkten, am 11. Mai 2009 und am 20. Januar 2010, erlassen wurde. Ein Einspracheentscheid kann indessen nicht in Teilentscheide aufgesplittet und so zu verschiedenen Zeitpunkten eröffnet werden. Wenn die Beschwerdegegnerin trotzdem auf diese Weise vorging, kann solches der Beschwerdeführerin nicht zum Nachteil gereichen. Ihr kann somit nicht vorgeworfen werden, sie hätte den Einspracheentscheid schon nach Kenntnisnahme der ihr am 22. September 2009 eröffneten Akten mit Beschwerde anfechten müssen, da dieser Einspracheentscheid vollständig erst am 20. Januar 2010 vorlag. Das Sozialversicherungsgericht ist demnach zu Recht auf die am 11. Februar 2010 erhobene Beschwerde eingetreten. Zu korrigieren ist jedoch der Verfahrensgegenstand im kantonalen Beschwerdeverfahren, der nicht die Verfügungen vom 20. Januar 2010, sondern den am 11. Mai 2009 erstellten und am 20. Januar 2010 ergänzten Einspracheentscheid umfasst.
4. 4.1 In materieller Hinsicht stellt der Einspracheentscheid vom 11. Mai 2009/20. Januar 2010 mit dem dort festgehaltenen Invaliditätsgrad von 100 % seit Mai 2001 und der Zusprechung einer ganzen Invalidenrente ab 1. Mai 2002 auf den psychiatrischen Untersuchungsbericht des RAD-Arztes pract. med. D._ ab. Dieser Bericht setzt sich mit den Administrativgutachten der MEDAS vom 6. Februar 2003, des ZMB vom 12. Dezember 2006 und vom 23. April 2007 sowie des Dr. med. S._ vom 23. Januar 2008 nicht auseinander. Vielmehr ging der RAD-Psychiater pract. med. D._ von einer völlig unzulänglichen Aktenlage aus, wenn er darlegte, im Vorfeld seien zwei in ihrer Interpretation bezüglich der Arbeitsfähigkeit divergierende, zum einen von der Invalidenversicherung, zum anderen von der Rechtsvertreterin des Versicherten in Auftrag gegebene psychiatrische Begutachtungen durchgeführt worden. Wie erwähnt, lag keineswegs nur ein im Auftrag der IV-Stelle erstattetes Gutachten vor, sondern deren drei. Schon aus diesem Grund hätte auf diesen Untersuchungsbericht des RAD-Psychiaters nicht abgestellt werden dürfen, weil darin das Vorhandensein wesentlicher Vorakten ignoriert wurde.
4.2 Med. pract. D._ schloss rückwirkend ab Mai 2001 auf eine deutlich reduzierte Arbeitsfähigkeit von rund 30 % in einem entsprechend angepassten Rahmen. Im Gutachten der MEDAS Basel war jedoch am 6. Januar 2003 festgehalten worden, aus rein psychiatrischer Sicht sei der Versicherte mit Rücksicht auf die leichtgradige depressive Störung mit eingeschränkter emotionaler Belastbarkeit und vermehrter Nervosität für eine den somatischen Beschwerden angepasste Tätigkeit um 30 % eingeschränkt. Gemäss Gesamtbeurteilung wurde der Versicherte als voll einsatzfähig für leichte Arbeit gemäss rheumatologischer Einschätzung betrachtet, während aus psychiatrischer Sicht eine Beeinträchtigung von 30 % bestehe; dies allerdings nur für die Zeit einer noch nicht adäquat behandelten Depression. In der Ergänzung des ZMB-Gutachtens wurde am 23. April 2007 dargelegt, dass die Arbeitsfähigkeit sowohl in der bisherigen wie auch in einer alternativen Tätigkeit als lediglich zu 30 % eingeschränkt eingeschätzt werden könne. Dr. med. S._ wiederum stellte im Gutachten vom 23. Januar 2008 eine Verschlechterung des Gesundheitszustandes fest und nahm ab sofort eine hälftige Arbeitsunfähigkeit an. In seiner Ergänzung vom 3. Februar 2008 setzte sich Dr. med. S._ auch eingehend mit dem Privatgutachten der Frau Dr. med. P._ auseinander und hielt an seiner am 23. Januar 2008 abgegebenen Einschätzung fest. Dabei vermerkte er, dass die Anerkennung einer Arbeitsunfähigkeit von 50 % dem Versicherten gerecht werde. Es ist nicht einsichtig, wie sich der RAD-Psychiater pract. med. D._ über diese zahlreichen echtzeitlichen Begutachtungen am 10. Februar 2009 einfach hinwegsetzen und eine seit Mai 2001 bestehende, lediglich 30 % betragende Arbeitsfähigkeit in einem angepassten Rahmen bescheinigen konnte. Um zu diesem Ergebnis zu gelangen, hätte er sich im Einzelnen mit den früheren Begutachtungen auseinandersetzen müssen. Davon hat er abgesehen. Es ist daher zu schliessen, dass RAD-Arzt D._ weitgehend die Einschätzung der Privatgutachterin Frau Dr. P._ übernommen hat, obwohl bereits Dr. med. S._ deren Angaben mit überzeugenden Argumenten in Frage gestellt hatte. Mit der auf der Beurteilung des RAD-Psychiaters pract. med. D._ basierenden Annahme einer lediglich noch 30 % betragenden Arbeitsfähigkeit in einem angepassten Rahmen seit Mai 2001 hat die Vorinstanz den Sachverhalt im Sinne von Art. 97 Abs. 1 BGG offensichtlich unrichtig festgestellt, weshalb das Bundesgericht nicht daran gebunden ist (E. 1 hievor).
4.3 Der von Beschwerdegegnerin und Vorinstanz als massgebend erachtete Bericht des RAD-Arztes D._ enthält verschiedene Diagnosen. Indessen ist nicht ersichtlich, ob und inwieweit diese tatsächlich einen Einfluss auf die Leistungsfähigkeit haben. Ebenso fehlt eine Auseinandersetzung mit der Frage, ob eine - nur ausnahmsweise gegebene - Unzumutbarkeit der Schmerzüberwindung bezüglich der (allenfalls) aus der somatoformen Schmerzstörung abgeleiteten Arbeitsunfähigkeit gegeben ist (BGE 130 V 352 E. 2.2.3 S. 353 f.). Schliesslich hat Dr. S._ auch auf die psychosozialen Faktoren hingewiesen, die sich nicht eindeutig vom psychischen Leiden mit Krankheitswert unterscheiden liessen. Die Kenntnis, in welchem Ausmass soziokulturelle Umstände zur Beeinträchtigung der Arbeitsfähigkeit führen, ist indessen erforderlich, da solche nicht als zu Erwerbsunfähigkeit führende Gesundheitsschäden zu verstehen sind (vgl. MEYER, Rechtsprechung des Bundesgerichts zum IVG, 2. Aufl. S. 24). Der RAD-Psychiater D._ setzte sich jedoch gleich wie die Privatgutachterin Frau Dr. med. P._ nicht einmal ansatzweise mit den invalidenversicherungsrechtlich nicht relevanten psychosozialen und soziokulturellen Faktoren auseinander. Tatsächlich ist jedoch, wenn Hinweise auf solche Faktoren vorliegen, unabdingbar, dass diese im Rahmen einer psychiatrischen Exploration berücksichtigt werden. Daher ist es unzulässig, auf eine psychiatrische Untersuchung für die Festlegung des Invaliditätsgrades abzustellen, die auf eine solche Unterscheidung verzichtet.
4.4 Aktenwidrig ist des Weiteren die Behauptung der Vorinstanz, Dr. S._ gehe von einer Arbeitsunfähigkeit des Beschwerdeführers aus, die durchaus höher als auf 50 % eingeschätzt werden könne, wenn nicht nur das depressive Zustandsbild, sondern daneben auch die Persönlichkeitsstörung des Versicherten berücksichtigt werde. Dr. S._ hat explizit angefügt, dass die Anerkennung einer Arbeitsunfähigkeit von 50 % dem Versicherten gerecht werde, was von der Vorinstanz unbeachtet gelassen wurde. Daher ist auch deren Annahme, Dr. med. S._ gehe von einer gleich hohen Arbeitsfähigkeit wie RAD-Arzt D._ und die Privatgutachterin Frau Dr. med. P._ aus, unrichtig. Die Schlussfolgerung der Vorinstanz, dass von einander widersprechenden Arztgutachten keine Rede sein könne, erweist sich daher schon im Vergleich mit der Expertise des Dr. med. S._ als falsch. Überdies vernachlässigt diese Aussage auch die Stellungnahmen der MEDAS Basel wie auch des ZMB, die, wie dargelegt, ebenfalls tiefere Arbeitsunfähigkeitsgrade attestiert haben. Somit liegt diesbezüglich ebenfalls eine offensichtlich unrichtige Sachverhaltsfeststellung des kantonalen Gerichts vor.
4.5 Zusammengefasst liegt somit sowohl eine unvollständige wie auch eine teilweise offensichtlich unrichtige Feststellung des Sachverhaltes durch die Vorinstanz vor, indem von den drei Administrativgutachten erheblich tiefere Arbeitsunfähigkeitsgrade bescheinigt werden als von dem von der Vorinstanz als massgebend erachteten RAD-Psychiater pract. med. D._. Ebenso fehlt für den gesamten Zeitraum seit 2001 eine Auseinandersetzung damit, ob in Bezug auf die Diagnose der anhaltenden somatoformen Schmerzstörung die Kriterien für eine ausnahmsweise Unüberwindbarkeit gegeben sind. Auch stellt sich die Frage der Therapierbarkeit solcher Beeinträchtigungen (BGE 127 V 294). Ebenfalls offen ist, ob es sich bei der diagnostizierten depressiven Symptomatik lediglich um eine reaktive Begleiterscheinung der somatoformen Schmerzstörung handelt und nicht um ein selbstständiges, vom psychogenen Schmerzsyndrom losgelöstes depressives Leiden im Sinne einer psychischen Komorbidität und ob überdies dieses Leiden gegebenenfalls als ausgewiesene Komorbidität von erheblicher Schwere, Intensität, Ausprägung und Dauer betrachtet werden könnte (BGE 130 V 352 E. 2.2.3 S. 353 und E. 3.3.1 S. 358). Ebenso fehlt eine invalidenversicherungsrechtliche Auseinandersetzung mit den psychosozialen und soziokulturellen Faktoren. Die Angelegenheit ist daher an die IV-Stelle zurückzuweisen, damit diese - vorzugsweise beim ZMB, das sich zuletzt polydisziplinär mit dem Versicherten befasst hat - ein Verlaufs- und Zusatzgutachten einholt, das über diese Fragen für den Zeitraum seit 2001 Auskunft gibt. Nicht abschliessend kann demgegenüber auf das von der Beschwerdeführerin eingereichte Privatgutachten des Dr. med. C._ abgestellt werden, da dieses insbesondere keine einlässliche Auseinandersetzung mit der retrospektiven Arbeitsunfähigkeit sei 2001 und auch keine Angaben über die Auswirkungen der psychosozialen Komponenten auf die Arbeitsfähigkeit enthält.
5. Entsprechend dem Ausgang des Verfahrens sind die Gerichtskosten der Beschwerdegegnerin und dem Versicherten je zur Hälfte aufzuerlegen. Als mit öffentlich-rechtlichen Aufgaben betraute Organisation hat die obsiegende Pensionskasse keinen Anspruch auf Parteientschädigung (Art. 68 Abs. 3 BGG; BGE 128 V 124 E. 5b S. 133).
Demnach erkennt das Bundesgericht:
1. Die Beschwerde wird gutgeheissen. Der Entscheid des Sozialversicherungsgerichts des Kantons Zürich vom 30. September 2011 sowie der Einspracheentscheid der IV-Stelle des Kantons Zürich vom 11. Mai 2009 und die Verfügungen vom 20. Januar 2010 werden aufgehoben. Die Sache wird an die IV-Stelle des Kantons Zürich zurückgewiesen, damit sie, nach erfolgter Abklärung im Sinne der Erwägungen, über den Anspruch des Versicherten auf eine Invalidenrente neu verfüge.
2. Von den Gerichtskosten von Fr. 500.- werden der IV-Stelle des Kantons Zürich und dem Versicherten je Fr. 250.- auferlegt.
3. Die Sache wird zur Neuverlegung der Kosten und der Parteientschädigung des vorangegangenen Verfahrens an das Sozialversicherungsgericht des Kantons Zürich zurückgewiesen.
4. Dieses Urteil wird den Parteien, O._, dem Sozialversicherungsgericht des Kantons Zürich und dem Bundesamt für Sozialversicherungen schriftlich mitgeteilt.
Luzern, 18. April 2012
Im Namen der II. sozialrechtlichen Abteilung
des Schweizerischen Bundesgerichts
Der Präsident: Meyer
Der Gerichtsschreiber: Widmer